Categories

Ths module can be used to retrieve categories to select specific templates when creating token collections

Categories are essential to create your own Token. A token can be anything you want: a piece of art, a ticket for a show a certificate for your antiquity... Categories are here to separate token templates so it is easier to find them all, all templates created fall under a category. Our API already has a set of generic categories for you but if you want a new category can be created for an specific company.

List Generic Categories

List all generic Categories

get

Gets all existing NFT category

Authorizations

x-w3block-api-keyx-w3block-idx-w3block-secretbearer

Responses

application/json

get

cURLJavaScriptPythonHTTP

curl -L \
  --url '/categories' \
  --header 'x-w3block-api-key: YOUR_API_KEY'

200

401

200

[
  {
    "id": "text",
    "companyId": "text",
    "subcategories": [
      {}
    ],
    "name": "text",
    "image": "text",
    "createdAt": "2025-04-10T15:31:33.842Z",
    "updatedAt": "2025-04-10T15:31:33.842Z"
  }
]

Create a Category for your Company

If you want a category that is not listed on the generics you can create your own category for your Company

post

Create a new NFT category for a company

Authorizations

x-w3block-api-keyx-w3block-idx-w3block-secretbearer

Path parameters

companyIdstringrequired

Body

namestringrequired

imagestringrequired

Responses

application/json

post

cURLJavaScriptPythonHTTP

curl -L \
  --request POST \
  --url '/{companyId}/categories' \
  --header 'x-w3block-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "image": "text"
  }'

201

401

201

{
  "id": "text",
  "companyId": "text",
  "subcategories": [
    {}
  ],
  "name": "text",
  "image": "text",
  "createdAt": "2025-04-10T15:31:33.842Z",
  "updatedAt": "2025-04-10T15:31:33.842Z"
}

List Categories by Company

List all Company Categories, this includes all categories you created plus all generic categories with a template that you created.

get

Gets an existing NFT category that matches the id

Authorizations

x-w3block-api-keyx-w3block-idx-w3block-secretbearer

Path parameters

idstringrequired

companyIdstringrequired

Responses

application/json

get

cURLJavaScriptPythonHTTP

curl -L \
  --url '/{companyId}/categories/{id}' \
  --header 'x-w3block-api-key: YOUR_API_KEY'

200

401

200

{
  "id": "text",
  "companyId": "text",
  "subcategories": [
    {}
  ],
  "name": "text",
  "image": "text",
  "createdAt": "2025-04-10T15:31:33.842Z",
  "updatedAt": "2025-04-10T15:31:33.842Z"
}

Update a Company Category

put

Updates an existing NFT category for a company

Authorizations

x-w3block-api-keyx-w3block-idx-w3block-secretbearer

Path parameters

idstringrequired

companyIdstringrequired

Body

namestringoptional

imagestringoptional

Responses

application/json

put

cURLJavaScriptPythonHTTP

curl -L \
  --request PUT \
  --url '/{companyId}/categories/{id}' \
  --header 'x-w3block-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "image": "text"
  }'

200

401

200

{
  "id": "text",
  "companyId": "text",
  "subcategories": [
    {}
  ],
  "name": "text",
  "image": "text",
  "createdAt": "2025-04-10T15:31:33.842Z",
  "updatedAt": "2025-04-10T15:31:33.842Z"
}

Get Category info

Deprecated

get

Gets an existing NFT category that matches the id

Authorizations

x-w3block-api-keyx-w3block-idx-w3block-secretbearer

Path parameters

idstringrequired

Responses

application/json

get

cURLJavaScriptPythonHTTP

curl -L \
  --url '/categories/{id}' \
  --header 'x-w3block-api-key: YOUR_API_KEY'

200

401

200

{
  "id": "text",
  "companyId": "text",
  "subcategories": [
    {}
  ],
  "name": "text",
  "image": "text",
  "createdAt": "2025-04-10T15:31:33.842Z",
  "updatedAt": "2025-04-10T15:31:33.842Z"
}