Items

Grant an item to a player

Mints an item of a given item type to the specified player. If name, description, image, or attributes are not provided, the item will be granted with the default metadata configured on the item type. On-chain, granting an item means an NFT is minted from the collection associated with the item type to the wallet of the given player.

POST/v1/items

Header parameters

Body

application/json

The item to be created

itemTypeId*string (uuid)

Unique identifier of the item

ownerPlayerId*string (uuid)

The id of the player who owns the item

tokenIdinteger

The on-chain unique identifier of the item within its given collection. The token id of the item is displayed in the Mythical Marketplace.

Example: 1

metadataItemMetadata (object)

Response

200

Success

Body

application/json

idstring (uuid)

Unique identifier of the item

itemTypeIdstring (uuid)

Unique identifier of the item

ownerPlayerIdstring (uuid)

The id of the player who owns the item

tokenIdinteger

The on-chain unique identifier of the item within its given collection. The token id of the item is displayed in the Mythical Marketplace.

Example: 1

stateenum

The current state of the item on chain

Example: "pending"

pendingfailed

metadataUrlstring

The location where the public metadata json is stored

Example: "http://url.com/1"

metadataItemMetadata (object)

Request

JavaScriptCurlPython

const response = await fetch('/v1/items', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "x-mythical-environment-id": "123e4567-e89b-12d3-a456-426614174000",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "itemTypeId": "f4e5d3a4-2a9b-4d9f-bc5a-73b3f0c47b5e",
      "ownerPlayerId": "9779f02d-5193-4ab1-ae15-f18e091f38e1"
    }),
});
const data = await response.json();

Response

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "itemTypeId": "123e4567-e89b-12d3-a456-426614174000",
  "ownerPlayerId": "123e4567-e89b-12d3-a456-426614174000",
  "tokenId": 1,
  "state": "pending",
  "metadataUrl": "http://url.com/1",
  "metadata": {
    "name": "text",
    "description": "text",
    "image": "text",
    "attributes": [
      {
        "type": "string",
        "value": "attrValue",
        "displayType": "number, boolean, string",
        "maxValue": 255
      }
    ]
  }
}

Search items

Retrieve a list of items. Supports filtering, sorting, and pagination.

POST/v1/items/search

Header parameters

Body

application/json

Defines the structure of a search request. Allows for filtering, and pagination of results when querying a list of items.

idsarray of string (uuid)

An array of items ids to search for.

itemTypeIdsarray of string (uuid)

An array of item type ids to find matching item instances for

ownerPlayerIdsarray of string (uuid)

An array of player ids who own the items you are interested in searching for

statesarray of string (string)

The current blockchain state of the items 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"

Response

200

Success

Body

application/json

idstring (uuid)

Unique identifier of the item

itemTypeIdstring (uuid)

Unique identifier of the item

ownerPlayerIdstring (uuid)

The id of the player who owns the item

tokenIdinteger

The on-chain unique identifier of the item within its given collection. The token id of the item is displayed in the Mythical Marketplace.

Example: 1

stateenum

The current state of the item on chain

Example: "pending"

pendingfailed

metadataUrlstring

The location where the public metadata json is stored

Example: "http://url.com/1"

metadataItemMetadata (object)

Request

JavaScriptCurlPython

const response = await fetch('/v1/items/search', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "x-mythical-environment-id": "123e4567-e89b-12d3-a456-426614174000",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "itemTypeIds": [
        "f4e5d3a4-2a9b-4d9f-bc5a-73b3f0c47b5e",
        "09babafe-3fe1-4913-94c3-eb79fc5acf00"
      ],
      "limit": 100,
      "skip": 0
    }),
});
const data = await response.json();

Response

200

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "itemTypeId": "123e4567-e89b-12d3-a456-426614174000",
    "ownerPlayerId": "123e4567-e89b-12d3-a456-426614174000",
    "tokenId": 1,
    "state": "pending",
    "metadataUrl": "http://url.com/1",
    "metadata": {
      "name": "text",
      "description": "text",
      "image": "text",
      "attributes": [
        {
          "type": "string",
          "value": "attrValue",
          "displayType": "number, boolean, string",
          "maxValue": 255
        }
      ]
    }
  }
]

Get an item

Retrieve a single item by id.

GET/v1/items/{itemId}

Path parameters

itemId*string

Header parameters

Response

200

Success

Body

application/json

idstring (uuid)

Unique identifier of the item

itemTypeIdstring (uuid)

Unique identifier of the item

ownerPlayerIdstring (uuid)

The id of the player who owns the item

tokenIdinteger

The on-chain unique identifier of the item within its given collection. The token id of the item is displayed in the Mythical Marketplace.

Example: 1

stateenum

The current state of the item on chain

Example: "pending"

pendingfailed

metadataUrlstring

The location where the public metadata json is stored

Example: "http://url.com/1"

metadataItemMetadata (object)

Request

JavaScriptCurlPython

const response = await fetch('/v1/items/{itemId}', {
    method: 'GET',
    headers: {
      "Authorization": "text",
      "x-mythical-environment-id": "123e4567-e89b-12d3-a456-426614174000"
    },
});
const data = await response.json();

Response

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "itemTypeId": "123e4567-e89b-12d3-a456-426614174000",
  "ownerPlayerId": "123e4567-e89b-12d3-a456-426614174000",
  "tokenId": 1,
  "state": "pending",
  "metadataUrl": "http://url.com/1",
  "metadata": {
    "name": "text",
    "description": "text",
    "image": "text",
    "attributes": [
      {
        "type": "string",
        "value": "attrValue",
        "displayType": "number, boolean, string",
        "maxValue": 255
      }
    ]
  }
}

Update an item

Update an item

PUT/v1/items/{itemId}

Path parameters

itemId*string

Header parameters

Body

application/json

Updates to be made to the item

metadataItemMetadata (object)

Response

200

Success

Body

application/json

idstring (uuid)

Unique identifier of the item

itemTypeIdstring (uuid)

Unique identifier of the item

ownerPlayerIdstring (uuid)

The id of the player who owns the item

tokenIdinteger

The on-chain unique identifier of the item within its given collection. The token id of the item is displayed in the Mythical Marketplace.

Example: 1

stateenum

The current state of the item on chain

Example: "pending"

pendingfailed

metadataUrlstring

The location where the public metadata json is stored

Example: "http://url.com/1"

metadataItemMetadata (object)

Request

JavaScriptCurlPython

const response = await fetch('/v1/items/{itemId}', {
    method: 'PUT',
    headers: {
      "Authorization": "text",
      "x-mythical-environment-id": "123e4567-e89b-12d3-a456-426614174000",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "metadata": {
        "name": "itemName",
        "description": "<p>itemDescription</p>",
        "image": "http://url.com/image",
        "attributes": [
          {
            "type": "attribute1",
            "value": 20,
            "displayType": "number",
            "maxValue": 100
          },
          {
            "type": "attribute2",
            "value": "value",
            "displayType": "string"
          }
        ],
        "__$markdownParsed": true
      }
    }),
});
const data = await response.json();

Response

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "itemTypeId": "123e4567-e89b-12d3-a456-426614174000",
  "ownerPlayerId": "123e4567-e89b-12d3-a456-426614174000",
  "tokenId": 1,
  "state": "pending",
  "metadataUrl": "http://url.com/1",
  "metadata": {
    "name": "text",
    "description": "text",
    "image": "text",
    "attributes": [
      {
        "type": "string",
        "value": "attrValue",
        "displayType": "number, boolean, string",
        "maxValue": 255
      }
    ]
  }
}

Transfer an item from one player to another

On-chain, this will transfer the item between the wallets of the provided players.

POST/v1/items/{itemId}/transfer

Path parameters

itemId*string (uuid)

The id of the item to transfer

Header parameters

Body

application/json

The ids of the players to transfer the item between

fromPlayerId*string (uuid)

Player from which the item will be transferred

toPlayerId*string (uuid)

Player to which the item will be transferred

Response

200

Success

Body

application/json

idstring (uuid)

Unique identifier of the item

itemTypeIdstring (uuid)

Unique identifier of the item

ownerPlayerIdstring (uuid)

The id of the player who owns the item

tokenIdinteger

The on-chain unique identifier of the item within its given collection. The token id of the item is displayed in the Mythical Marketplace.

Example: 1

stateenum

The current state of the item on chain

Example: "pending"

pendingfailed

metadataUrlstring

The location where the public metadata json is stored

Example: "http://url.com/1"

metadataItemMetadata (object)

Request

JavaScriptCurlPython

const response = await fetch('/v1/items/{itemId}/transfer', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "x-mythical-environment-id": "123e4567-e89b-12d3-a456-426614174000",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "fromPlayerId": "b915c482-1170-4dc7-819e-8ebf83569bc4",
      "toPlayerId": "3616cde1-fb31-48aa-8a31-32aed792cb7d"
    }),
});
const data = await response.json();

Response

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "itemTypeId": "123e4567-e89b-12d3-a456-426614174000",
  "ownerPlayerId": "123e4567-e89b-12d3-a456-426614174000",
  "tokenId": 1,
  "state": "pending",
  "metadataUrl": "http://url.com/1",
  "metadata": {
    "name": "text",
    "description": "text",
    "image": "text",
    "attributes": [
      {
        "type": "string",
        "value": "attrValue",
        "displayType": "number, boolean, string",
        "maxValue": 255
      }
    ]
  }
}

Burn an item

On-chain, this will irreversably transfer the item to the zero address (0x000...), effectively destroying the item.

POST/v1/items/{itemId}/burn

Path parameters

itemId*string

Header parameters

Response

200

Success

Body

application/json

idstring (uuid)

Unique identifier of the item

itemTypeIdstring (uuid)

Unique identifier of the item

ownerPlayerIdstring (uuid)

The id of the player who owns the item

tokenIdinteger

The on-chain unique identifier of the item within its given collection. The token id of the item is displayed in the Mythical Marketplace.

Example: 1

stateenum

The current state of the item on chain

Example: "pending"

pendingfailed

metadataUrlstring

The location where the public metadata json is stored

Example: "http://url.com/1"

metadataItemMetadata (object)

Request

JavaScriptCurlPython

const response = await fetch('/v1/items/{itemId}/burn', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "x-mythical-environment-id": "123e4567-e89b-12d3-a456-426614174000"
    },
});
const data = await response.json();

Response

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "itemTypeId": "123e4567-e89b-12d3-a456-426614174000",
  "ownerPlayerId": "123e4567-e89b-12d3-a456-426614174000",
  "tokenId": 1,
  "state": "pending",
  "metadataUrl": "http://url.com/1",
  "metadata": {
    "name": "text",
    "description": "text",
    "image": "text",
    "attributes": [
      {
        "type": "string",
        "value": "attrValue",
        "displayType": "number, boolean, string",
        "maxValue": 255
      }
    ]
  }
}