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

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

itemTypeIdstring · uuidrequired

Unique identifier of the item

ownerPlayerIdstring · uuidrequired

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

metadataobject

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v1/items' \
  --header 'Authorization: text' \
  --header 'x-mythical-environment-id: 123e4567-e89b-12d3-a456-426614174000' \
  --header 'Content-Type: application/json' \
  --data '{
    "itemTypeId": "f4e5d3a4-2a9b-4d9f-bc5a-73b3f0c47b5e",
    "ownerPlayerId": "9779f02d-5193-4ab1-ae15-f18e091f38e1"
  }'

200

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
      }
    ]
  }
}

Success

Search items

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

post

/v1/items/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 ids to search for.

itemTypeIdsstring · uuid[]

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

ownerPlayerIdsstring · uuid[]

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

statesstring · 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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v1/items/search' \
  --header 'Authorization: text' \
  --header 'x-mythical-environment-id: 123e4567-e89b-12d3-a456-426614174000' \
  --header 'Content-Type: application/json' \
  --data '{
    "itemTypeIds": [
      "f4e5d3a4-2a9b-4d9f-bc5a-73b3f0c47b5e",
      "09babafe-3fe1-4913-94c3-eb79fc5acf00"
    ],
    "limit": 100,
    "skip": 0
  }'

200

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
        }
      ]
    }
  }
]

Success

Get an item

Retrieve a single item by id.

get

/v1/items/{itemId}

Authorizations

Path parameters

itemIdstringrequired

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/items/{itemId}' \
  --header 'Authorization: text' \
  --header 'x-mythical-environment-id: 123e4567-e89b-12d3-a456-426614174000'

200

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
      }
    ]
  }
}

Success

Update an item

Update an item

put

/v1/items/{itemId}

Authorizations

Path parameters

itemIdstringrequired

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

metadataobject

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/v1/items/{itemId}' \
  --header 'Authorization: text' \
  --header 'x-mythical-environment-id: 123e4567-e89b-12d3-a456-426614174000' \
  --header 'Content-Type: application/json' \
  --data '{
    "metadata": {
      "name": "itemName",
      "description": "itemDescription",
      "image": "http://url.com/image",
      "attributes": [
        {
          "type": "attribute1",
          "value": 20,
          "displayType": "number",
          "maxValue": 100
        },
        {
          "type": "attribute2",
          "value": "value",
          "displayType": "string"
        }
      ]
    }
  }'

200

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
      }
    ]
  }
}

Success

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

Authorizations

Path parameters

itemIdstring · uuidrequired

The id of the item to transfer

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

fromPlayerIdstring · uuidrequired

Player from which the item will be transferred

toPlayerIdstring · uuidrequired

Player to which the item will be transferred

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v1/items/{itemId}/transfer' \
  --header 'Authorization: text' \
  --header 'x-mythical-environment-id: 123e4567-e89b-12d3-a456-426614174000' \
  --header 'Content-Type: application/json' \
  --data '{
    "fromPlayerId": "b915c482-1170-4dc7-819e-8ebf83569bc4",
    "toPlayerId": "3616cde1-fb31-48aa-8a31-32aed792cb7d"
  }'

200

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
      }
    ]
  }
}

Success

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

Authorizations

Path parameters

itemIdstringrequired

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 \
  --request POST \
  --url '/v1/items/{itemId}/burn' \
  --header 'Authorization: text' \
  --header 'x-mythical-environment-id: 123e4567-e89b-12d3-a456-426614174000'

200

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
      }
    ]
  }
}

Success