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
Responses
200Success
application/json
get
GET /categories HTTP/1.1
Host: 
x-w3block-api-key: YOUR_API_KEY
Accept: */*

[
  {
    "id": "text",
    "companyId": "text",
    "subcategories": [
      {}
    ],
    "name": "text",
    "image": "text",
    "createdAt": "2025-07-05T14:57:47.790Z",
    "updatedAt": "2025-07-05T14:57:47.790Z"
  }
]

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
Path parameters
companyIdstringRequired
Body
namestringRequired
imagestringRequired
Responses
201Success
application/json
post
POST /{companyId}/categories HTTP/1.1
Host: 
x-w3block-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "name": "text",
  "image": "text"
}
{
  "id": "text",
  "companyId": "text",
  "subcategories": [
    {}
  ],
  "name": "text",
  "image": "text",
  "createdAt": "2025-07-05T14:57:47.790Z",
  "updatedAt": "2025-07-05T14:57:47.790Z"
}

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
Path parameters
idstringRequired
companyIdstringRequired
Responses
200Success
application/json
get
GET /{companyId}/categories/{id} HTTP/1.1
Host: 
x-w3block-api-key: YOUR_API_KEY
Accept: */*

{
  "id": "text",
  "companyId": "text",
  "subcategories": [
    {}
  ],
  "name": "text",
  "image": "text",
  "createdAt": "2025-07-05T14:57:47.790Z",
  "updatedAt": "2025-07-05T14:57:47.790Z"
}

Update a Company Category

put

Updates an existing NFT category for a company

Authorizations
Path parameters
idstringRequired
companyIdstringRequired
Body
namestringOptional
imagestringOptional
Responses
200Success
application/json
put
PUT /{companyId}/categories/{id} HTTP/1.1
Host: 
x-w3block-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "name": "text",
  "image": "text"
}
{
  "id": "text",
  "companyId": "text",
  "subcategories": [
    {}
  ],
  "name": "text",
  "image": "text",
  "createdAt": "2025-07-05T14:57:47.790Z",
  "updatedAt": "2025-07-05T14:57:47.790Z"
}

Get Category info

Deprecated
get

Gets an existing NFT category that matches the id

Authorizations
Path parameters
idstringRequired
Responses
200Success
application/json
get
GET /categories/{id} HTTP/1.1
Host: 
x-w3block-api-key: YOUR_API_KEY
Accept: */*

{
  "id": "text",
  "companyId": "text",
  "subcategories": [
    {}
  ],
  "name": "text",
  "image": "text",
  "createdAt": "2025-07-05T14:57:47.790Z",
  "updatedAt": "2025-07-05T14:57:47.790Z"
}

PreviousRoyalty EligibleNextSubcategories

Last updated