Item Types

Create an item type

Creating an item type means a collection will be deployed on-chain, from which items (NFTs) are minted when using the POST /items endpoint. An item type requires valid default metadata in order to be deployed.

post

/v1/item-types

Authorizations

Header parameters

Authorizationstring · Bearer {bearerToken}required

Bearer token to be passed for Authorization. Can be retrieved from v1/auth/token

x-mythical-environment-idstring · uuidrequired

Identifier for the environment that this request should interact with

Body

collectionNamestringrequired

The name of the collection on-chain. This is a unique identifier which helps ensure you're looking at the right asset on the block explorer. It's not displayed in the Mythical Marketplace. This is immutable.

maxSupplyinteger

The maximum quantity of the item which can be granted.

mintModestring · enumrequired

Describes how the tokenId is chosen when new items are minted.

• serial: Each consecutive tokenId is incremented from the previous.
• random: Each consecutive tokenId is a random number between 1 and the maxSupply.
• controlled: The tokenId is input by the studio when the item is minted.

Options: serial, random

defaultMetadataobject

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v1/item-types' \
  --header 'Authorization: text' \
  --header 'x-mythical-environment-id: 123e4567-e89b-12d3-a456-426614174000' \
  --header 'Content-Type: application/json' \
  --data '{
    "collectionName": "collectionName",
    "maxSupply": 1000,
    "mintMode": "serial",
    "defaultMetadata": {
      "name": "itemName",
      "description": "itemDescription",
      "image": "http://url.com/image",
      "attributes": [
        {
          "type": "attribute1",
          "value": 10,
          "displayType": "number",
          "maxValue": 100
        },
        {
          "type": "attribute2",
          "value": "value",
          "displayType": "string"
        }
      ]
    }
  }'

200

200

{
  "id": "f4e5d3a4-2a9b-4d9f-bc5a-73b3f0c47b5e",
  "state": "pending",
  "collectionName": "collectionName",
  "maxSupply": 1000,
  "issuedSupply": 0,
  "circulatingSupply": 0,
  "mintMode": "serial",
  "defaultMetadata": {
    "name": "itemName",
    "description": "itemDescription",
    "image": "http://url.com/image",
    "attributes": [
      {
        "type": "attribute1",
        "value": 10,
        "displayType": "number",
        "maxValue": 100
      },
      {
        "type": "attribute2",
        "value": "value",
        "displayType": "string"
      }
    ]
  }
}

Success

Search item types

Retrieve a list of item types. Supports filtering, sorting, and pagination.

post

/v1/item-types/search

Authorizations

Header parameters

Authorizationstring · Bearer {bearerToken}required

Bearer token to be passed for Authorization. Can be retrieved from v1/auth/token

x-mythical-environment-idstring · uuidrequired

Identifier for the environment that this request should interact with

Body

idsstring · uuid[]

An array of items type ids to search for.

collectionNamesstring · string[]

An array of collection names to find the matching item types for

statesstring · string[]

The current blockchain state of the item type(s) that you are searching for

mintModesstring · string[]

The mint mode (serial, random, etc) of the item type(s) that you are searching for

limitstring

The maximum number of items you would like returned in this search

Example: 10

skipstring

How many records should be skipped in the result set before returning results?

Example: 10

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v1/item-types/search' \
  --header 'Authorization: text' \
  --header 'x-mythical-environment-id: 123e4567-e89b-12d3-a456-426614174000' \
  --header 'Content-Type: application/json' \
  --data '{
    "mintModes": [
      "serial"
    ],
    "limit": 100,
    "skip": 0
  }'

200

200

[
  {
    "id": "f4e5d3a4-2a9b-4d9f-bc5a-73b3f0c47b5e",
    "state": "pending",
    "collectionName": "collectionName",
    "maxSupply": 1000,
    "issuedSupply": 0,
    "circulatingSupply": 0,
    "mintMode": "serial",
    "defaultMetadata": {
      "name": "itemName",
      "description": "itemDescription",
      "image": "http://url.com/image",
      "attributes": [
        {
          "type": "attribute1",
          "value": 10,
          "displayType": "number",
          "maxValue": 100
        },
        {
          "type": "attribute2",
          "value": "value",
          "displayType": "string"
        }
      ]
    }
  }
]

Success

Get an item type by item type id

Retrieve a single item type by id.

get

/v1/item-types/{itemTypeId}

Authorizations

Path parameters

itemTypeIdstringrequired

Header parameters

Authorizationstring · Bearer {bearerToken}required

Bearer token to be passed for Authorization. Can be retrieved from v1/auth/token

x-mythical-environment-idstring · uuidrequired

Identifier for the environment that this request should interact with

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1/item-types/{itemTypeId}' \
  --header 'Authorization: text' \
  --header 'x-mythical-environment-id: 123e4567-e89b-12d3-a456-426614174000'

200

200

{
  "id": "f4e5d3a4-2a9b-4d9f-bc5a-73b3f0c47b5e",
  "state": "pending",
  "collectionName": "collectionName",
  "maxSupply": 1000,
  "issuedSupply": 0,
  "circulatingSupply": 0,
  "mintMode": "serial",
  "defaultMetadata": {
    "name": "itemName",
    "description": "itemDescription",
    "image": "http://url.com/image",
    "attributes": [
      {
        "type": "attribute1",
        "value": 10,
        "displayType": "number",
        "maxValue": 100
      },
      {
        "type": "attribute2",
        "value": "value",
        "displayType": "string"
      }
    ]
  }
}

Success

Update an item type

Update the mutable attributes of an item type.

put

/v1/item-types/{itemTypeId}

Authorizations

Path parameters

itemTypeIdstringrequired

Header parameters

Authorizationstring · Bearer {bearerToken}required

Bearer token to be passed for Authorization. Can be retrieved from v1/auth/token

x-mythical-environment-idstring · uuidrequired

Identifier for the environment that this request should interact with

Body

defaultMetadataobject

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/v1/item-types/{itemTypeId}' \
  --header 'Authorization: text' \
  --header 'x-mythical-environment-id: 123e4567-e89b-12d3-a456-426614174000' \
  --header 'Content-Type: application/json' \
  --data '{
    "defaultMetadata": {
      "name": "text",
      "description": "text",
      "image": "text",
      "attributes": [
        {
          "type": "string",
          "value": "attrValue",
          "displayType": "number, boolean, string",
          "maxValue": 255
        }
      ]
    }
  }'

200

200

{
  "id": "f4e5d3a4-2a9b-4d9f-bc5a-73b3f0c47b5e",
  "state": "pending",
  "collectionName": "collectionName",
  "maxSupply": 1000,
  "issuedSupply": 0,
  "circulatingSupply": 0,
  "mintMode": "serial",
  "defaultMetadata": {
    "name": "itemName",
    "description": "itemDescription",
    "image": "http://url.com/image",
    "attributes": [
      {
        "type": "attribute1",
        "value": 10,
        "displayType": "number",
        "maxValue": 100
      },
      {
        "type": "attribute2",
        "value": "value",
        "displayType": "string"
      }
    ]
  }
}

Success