Token Collections
Token Collections are a group of tokens that you define that are similar to each other. When you create a collection it can have as many tokens as you want. When you create a collection it starts as a draft. When you publish it you can choose any number of tokens to mint from your collection, you do not need to mint them all right away. Then the collection becomes published.
Before you publish your collection it is recommended that you estimate the gas that will be used for it so that you know you have enough in your wallet to make the operation.
Create a collection draft
To create you collection draft you will need to select a contract that you published, along with other parameters for your tokens
Create a token collection
uuid
Token Collection
https://dummyimage.com/600x400/fff/000
{"title":"Title example"}
0
*
true
{"sendWebhookWhenTokenEditionIsUpdated":false}
POST /{companyId}/token-collections HTTP/1.1
Host:
x-w3block-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 311
{
"contractId": "",
"subcategoryId": "uuid",
"name": "Token Collection",
"description": "",
"mainImage": "https://dummyimage.com/600x400/fff/000",
"tokenData": {
"title": "Title example"
},
"quantity": 0,
"rangeInitialToMint": "*",
"ownerAddress": null,
"similarTokens": true,
"settings": {
"sendWebhookWhenTokenEditionIsUpdated": false
}
}
{
"id": "text",
"companyId": "text",
"deletedAt": "2025-07-14T20:02:30.505Z",
"createdAt": "2025-07-14T20:02:30.505Z",
"updatedAt": "2025-07-14T20:02:30.505Z",
"status": "draft",
"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-07-14T20:02:30.505Z",
"createdAt": "2025-07-14T20:02:30.505Z",
"updatedAt": "2025-07-14T20:02:30.505Z",
"transferWhitelistId": "123e4567-e89b-12d3-a456-426614174000",
"minterWhitelistId": "123e4567-e89b-12d3-a456-426614174000",
"maxSupply": 1
},
"contractId": "text",
"subcategory": {
"id": "text",
"companyId": "text",
"category": {
"id": "text",
"companyId": "text",
"subcategories": [
{}
],
"name": "text",
"image": "text",
"createdAt": "2025-07-14T20:02:30.505Z",
"updatedAt": "2025-07-14T20:02:30.505Z"
},
"categoryId": "text",
"name": "text",
"tokenTemplate": {
"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": {}
}
},
"deletedAt": "2025-07-14T20:02:30.505Z",
"createdAt": "2025-07-14T20:02:30.505Z",
"updatedAt": "2025-07-14T20:02:30.505Z",
"certificateTemplate": "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
}
}
Get your token collections
List collections by company
1
10
DESC
Possible values: GET /{companyId}/token-collections HTTP/1.1
Host:
x-w3block-api-key: YOUR_API_KEY
Accept: */*
{
"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",
"deletedAt": "2025-07-14T20:02:30.505Z",
"createdAt": "2025-07-14T20:02:30.505Z",
"updatedAt": "2025-07-14T20:02:30.505Z",
"status": "draft",
"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-07-14T20:02:30.505Z",
"createdAt": "2025-07-14T20:02:30.505Z",
"updatedAt": "2025-07-14T20:02:30.505Z",
"transferWhitelistId": "123e4567-e89b-12d3-a456-426614174000",
"minterWhitelistId": "123e4567-e89b-12d3-a456-426614174000",
"maxSupply": 1
},
"contractId": "text",
"subcategory": {
"id": "text",
"companyId": "text",
"category": {
"id": "text",
"companyId": "text",
"subcategories": [
{}
],
"name": "text",
"image": "text",
"createdAt": "2025-07-14T20:02:30.505Z",
"updatedAt": "2025-07-14T20:02:30.505Z"
},
"categoryId": "text",
"name": "text",
"tokenTemplate": {
"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": {}
}
},
"deletedAt": "2025-07-14T20:02:30.505Z",
"createdAt": "2025-07-14T20:02:30.505Z",
"updatedAt": "2025-07-14T20:02:30.505Z",
"certificateTemplate": "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
}
}
]
}
Publish a token collection
When you publish a collection what you actually do is mint a certain number of tokens from your collection, you can choose to mint from 1 to all of your collections tokens when you initially publish you contract. You can later mint the rest of the collections tokens in any quantity you like at a time
Publish a token Collection
Token Collection
https://dummyimage.com/600x400/fff/000
{"title":"Title example"}
0
*
{"sendWebhookWhenTokenEditionIsUpdated":false}
PATCH /{companyId}/token-collections/publish/{id} HTTP/1.1
Host:
x-w3block-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 267
{
"contractId": "",
"name": "Token Collection",
"description": "",
"mainImage": "https://dummyimage.com/600x400/fff/000",
"tokenData": {
"title": "Title example"
},
"quantity": 0,
"rangeInitialToMint": "*",
"ownerAddress": null,
"settings": {
"sendWebhookWhenTokenEditionIsUpdated": false
}
}
{
"tokenCollection": {
"id": "text",
"companyId": "text",
"deletedAt": "2025-07-14T20:02:30.505Z",
"createdAt": "2025-07-14T20:02:30.505Z",
"updatedAt": "2025-07-14T20:02:30.505Z",
"status": "draft",
"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-07-14T20:02:30.505Z",
"createdAt": "2025-07-14T20:02:30.505Z",
"updatedAt": "2025-07-14T20:02:30.505Z",
"transferWhitelistId": "123e4567-e89b-12d3-a456-426614174000",
"minterWhitelistId": "123e4567-e89b-12d3-a456-426614174000",
"maxSupply": 1
},
"contractId": "text",
"subcategory": {
"id": "text",
"companyId": "text",
"category": {
"id": "text",
"companyId": "text",
"subcategories": [
{}
],
"name": "text",
"image": "text",
"createdAt": "2025-07-14T20:02:30.505Z",
"updatedAt": "2025-07-14T20:02:30.505Z"
},
"categoryId": "text",
"name": "text",
"tokenTemplate": {
"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": {}
}
},
"deletedAt": "2025-07-14T20:02:30.505Z",
"createdAt": "2025-07-14T20:02:30.505Z",
"updatedAt": "2025-07-14T20:02:30.505Z",
"certificateTemplate": "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
}
}
}
Estimate publish Gas
Estimate gas to publish collection
1
GET /{companyId}/token-collections/estimate-gas?contractId=text&initialQuantityToMint=1 HTTP/1.1
Host:
x-w3block-api-key: YOUR_API_KEY
Accept: */*
{
"totalGas": 1,
"totalGasPrice": {
"safe": "text",
"proposed": "text",
"fast": "text"
}
}
Get a token collection
Get a collection by id
GET /{companyId}/token-collections/{id} HTTP/1.1
Host:
x-w3block-api-key: YOUR_API_KEY
Accept: */*
{
"id": "text",
"companyId": "text",
"deletedAt": "2025-07-14T20:02:30.505Z",
"createdAt": "2025-07-14T20:02:30.505Z",
"updatedAt": "2025-07-14T20:02:30.505Z",
"status": "draft",
"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-07-14T20:02:30.505Z",
"createdAt": "2025-07-14T20:02:30.505Z",
"updatedAt": "2025-07-14T20:02:30.505Z",
"transferWhitelistId": "123e4567-e89b-12d3-a456-426614174000",
"minterWhitelistId": "123e4567-e89b-12d3-a456-426614174000",
"maxSupply": 1
},
"contractId": "text",
"subcategory": {
"id": "text",
"companyId": "text",
"category": {
"id": "text",
"companyId": "text",
"subcategories": [
{}
],
"name": "text",
"image": "text",
"createdAt": "2025-07-14T20:02:30.505Z",
"updatedAt": "2025-07-14T20:02:30.505Z"
},
"categoryId": "text",
"name": "text",
"tokenTemplate": {
"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": {}
}
},
"deletedAt": "2025-07-14T20:02:30.505Z",
"createdAt": "2025-07-14T20:02:30.505Z",
"updatedAt": "2025-07-14T20:02:30.505Z",
"certificateTemplate": "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
}
}
Edit a collection draft
Edit draft collection
Token Collection
https://dummyimage.com/600x400/fff/000
{"title":"Title example"}
0
*
{"sendWebhookWhenTokenEditionIsUpdated":false}
PUT /{companyId}/token-collections/{id} HTTP/1.1
Host:
x-w3block-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 267
{
"contractId": "",
"name": "Token Collection",
"description": "",
"mainImage": "https://dummyimage.com/600x400/fff/000",
"tokenData": {
"title": "Title example"
},
"quantity": 0,
"rangeInitialToMint": "*",
"ownerAddress": null,
"settings": {
"sendWebhookWhenTokenEditionIsUpdated": false
}
}
{
"id": "text",
"companyId": "text",
"deletedAt": "2025-07-14T20:02:30.505Z",
"createdAt": "2025-07-14T20:02:30.505Z",
"updatedAt": "2025-07-14T20:02:30.505Z",
"status": "draft",
"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-07-14T20:02:30.505Z",
"createdAt": "2025-07-14T20:02:30.505Z",
"updatedAt": "2025-07-14T20:02:30.505Z",
"transferWhitelistId": "123e4567-e89b-12d3-a456-426614174000",
"minterWhitelistId": "123e4567-e89b-12d3-a456-426614174000",
"maxSupply": 1
},
"contractId": "text",
"subcategory": {
"id": "text",
"companyId": "text",
"category": {
"id": "text",
"companyId": "text",
"subcategories": [
{}
],
"name": "text",
"image": "text",
"createdAt": "2025-07-14T20:02:30.505Z",
"updatedAt": "2025-07-14T20:02:30.505Z"
},
"categoryId": "text",
"name": "text",
"tokenTemplate": {
"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": {}
}
},
"deletedAt": "2025-07-14T20:02:30.505Z",
"createdAt": "2025-07-14T20:02:30.505Z",
"updatedAt": "2025-07-14T20:02:30.505Z",
"certificateTemplate": "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
}
}
Burn a token collection
Burn a collection by id
DELETE /{companyId}/token-collections/{id}/burn HTTP/1.1
Host:
x-w3block-api-key: YOUR_API_KEY
Accept: */*
No content
Delete a token collection draft
Delete a draft collection by id
DELETE /{companyId}/token-collections/{id}/draft HTTP/1.1
Host:
x-w3block-api-key: YOUR_API_KEY
Accept: */*
No content
Last updated