Apps service

The Item API provides endpoints for managing items within an application. You can create items, update their information, and retrieve item data. Additionally, you can remove items and check item availability based on the address and token ID. This API enables seamless item management and access to relevant item data.

The Apps API allows you to manage applications. You can create applications, update their information, and retrieve application data. The API also provides endpoints to retrieve rich application data, check application availability by name, and search for applications based on specific criteria. This API facilitates efficient application management and access to relevant application information.

Swagger docs link:

https://api.metaproprotocol.com/ms/teams/docs

Item

PreviousTeams service NextNft service

Last updated 1 year ago

Returns a list of Applications

get

Query parameters

skipnumberoptional

Example: 2

limitnumber · min: 1optional

Example: 2

namestring · min: 2 · max: 100optional

Example: This is my app

teamIdstring · min: 40 · max: 60optional

Example: 3895457a-94ff-41ae-8677-f7753bc5a81d

categoriesstring · enum[]optional

Example: ["Action","Adventure"]

appStorestring · min: 2 · max: 1500optional

Example: https://app-store-link.com/my-app

networksstring · enum[]optional

Example: ["bnb-chain"]

websitestring · min: 2 · max: 1500optional

Example: https://my-website.com

createdBystringoptional

User ID

Example: d4be5783-5373-4cca-ac96-1021277c3336

addressstring · min: 35 · max: 55optional

Token address

Example: 0xa293d68684be29540838dc8a0222de0c43c6b5b4

_tokenIdnumber · min: 1 · max: 10000000optional

Example: 2137

appIdsstring[]optional

_itemsbooleanoptional

teamIdsstring[]optional

platformsstring[]optional

statusesstring · enum[]optional

enginesstring · enum[]optional

downloadablebooleanoptional

internalbooleanoptional

patchkitAppIdsstring[]optional

protocolsstring[]optional

leaderboardbooleanoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '..//v1/apps'

200

400

404

{
  "results": [
    {
      "appId": "1aea9899-3f43-4ea6-852a-dddddbbc48c5",
      "patchkitAppId": "d4be5783-5373-4cca-ac96-1021277c3336",
      "name": "This is my app",
      "description": "Full app description",
      "team": "My team name",
      "teamId": "3895457a-94ff-41ae-8677-f7753bc5a81d",
      "categories": [
        "Action",
        "Adventure"
      ],
      "releaseDate": "25-05-2023",
      "platform": [
        {
          "platform": "xbox",
          "storeUrl": "https://store-url.com"
        },
        {
          "platform": "macos",
          "storeUrl": "https://store-url.com"
        }
      ],
      "status": "in development",
      "appStore": "https://app-store-link.com/my-app",
      "engine": "Unreal engine",
      "networks": [
        "bnb-chain"
      ],
      "website": "https://my-website.com",
      "gallery": [
        "text"
      ],
      "createdBy": "d4be5783-5373-4cca-ac96-1021277c3336",
      "favorites": 20,
      "wishes": 20,
      "createdAt": "2022-05-25T16:17:01.797Z",
      "updatedAt": "2022-05-25T16:17:01.797Z",
      "items": [
        {
          "itemId": "97c76a03-54b8-41c5-91b3-1e7f3c76ca16",
          "patchkitAppId": "d4be5783-5373-4cca-ac96-1021277c3336",
          "address": "0xa293d68684be29540838dc8a0222de0c43c6b5b4",
          "developmentStatus": "selected for development",
          "appId": "1aea9899-3f43-4ea6-852a-dddddbbc48c5",
          "teamId": "d69b15b2-2f41-4204-af19-34d683d04089",
          "_tokenId": 2137,
          "creationBlock": 21722028,
          "createdBy": "0xa293d68684be29540838dc8a0222de0c43c6b5b4",
          "creator": "0xa293d68684be29540838dc8a0222de0c43c6b5b4",
          "description": "Full token description",
          "image": "https://image.com/",
          "tokenName": "Token name",
          "_bucketHash": "def7cffa-5b05-4811-a265-1df98d2790b5",
          "filesSpec": {
            "item_experience": [
              {
                "key": "asset_size",
                "value": 123,
                "value_type": "integer"
              }
            ],
            "common": {
              "standard": [
                {
                  "key": "asset_size",
                  "value": 123,
                  "value_type": "integer"
                }
              ],
              "2d_spec": [
                {
                  "key": "asset_size",
                  "value": 123,
                  "value_type": "integer"
                }
              ],
              "3d_spec": [
                {
                  "key": "asset_size",
                  "value": 123,
                  "value_type": "integer"
                }
              ],
              "sound_spec": [
                {
                  "key": "asset_size",
                  "value": 123,
                  "value_type": "integer"
                }
              ]
            }
          },
          "properties": {
            "collection": "Zombie",
            "properties_eyes": {
              "name": "eyes",
              "value": "big",
              "display_value": "Big Eyes"
            },
            "levels_speed": {
              "name": "speed",
              "value": 10,
              "max_value": 200,
              "display_type": "level"
            },
            "boosts_speed": {
              "name": "speed",
              "value": 5,
              "display_type": "boost_percentage"
            }
          }
        }
      ],
      "protocols": [
        "text"
      ],
      "socialMedia": [
        {
          "name": "facebook",
          "value": "https://facebook.com/"
        },
        {
          "name": "instagram",
          "value": "https://instagram.com/"
        }
      ]
    }
  ],
  "count": 1
}

Returns App data

get

Authorizations

Query parameters

appIdsstring[]optional

_itemsbooleanoptional

teamIdsstring[]optional

Header parameters

Authorizationstringrequired

asduf823hf-sa98ehf938rh

x-account-walletstringrequired

0xd1afbab5cacb45491ce002a6026c1401340eae6a

x-account-useridstringrequired

5a945f88-1de8cb-c6a1b4-1314ebac6bd1

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '..//v1/apps/rich' \
  --header 'Authorization: text' \
  --header 'x-account-wallet: text' \
  --header 'x-account-userid: text'

200

400

401

403

404

[
  {
    "appId": "1aea9899-3f43-4ea6-852a-dddddbbc48c5",
    "patchkitAppId": "d4be5783-5373-4cca-ac96-1021277c3336",
    "appKey": "20989a02-f0c5-4a43-b3a1-1b8a4f6275b8",
    "name": "This is my app",
    "description": "Full app description",
    "team": "My team name",
    "teamId": "3895457a-94ff-41ae-8677-f7753bc5a81d",
    "categories": [
      "Action",
      "Adventure"
    ],
    "releaseDate": "25-05-2023",
    "platform": [
      {
        "platform": "xbox",
        "storeUrl": "https://store-url.com"
      },
      {
        "platform": "macos",
        "storeUrl": "https://store-url.com"
      }
    ],
    "status": "in development",
    "appStore": "https://app-store-link.com/my-app",
    "engine": "Unreal engine",
    "networks": [
      "bnb-chain"
    ],
    "website": "https://my-website.com",
    "gallery": [
      "text"
    ],
    "createdBy": "d4be5783-5373-4cca-ac96-1021277c3336",
    "favorites": 20,
    "wishes": 20,
    "createdAt": "2022-05-25T16:17:01.797Z",
    "updatedAt": "2022-05-25T16:17:01.797Z",
    "items": [
      {
        "itemId": "97c76a03-54b8-41c5-91b3-1e7f3c76ca16",
        "patchkitAppId": "d4be5783-5373-4cca-ac96-1021277c3336",
        "address": "0xa293d68684be29540838dc8a0222de0c43c6b5b4",
        "developmentStatus": "selected for development",
        "appId": "1aea9899-3f43-4ea6-852a-dddddbbc48c5",
        "teamId": "d69b15b2-2f41-4204-af19-34d683d04089",
        "_tokenId": 2137,
        "creationBlock": 21722028,
        "createdBy": "0xa293d68684be29540838dc8a0222de0c43c6b5b4",
        "creator": "0xa293d68684be29540838dc8a0222de0c43c6b5b4",
        "description": "Full token description",
        "image": "https://image.com/",
        "tokenName": "Token name",
        "_bucketHash": "def7cffa-5b05-4811-a265-1df98d2790b5",
        "filesSpec": {
          "item_experience": [
            {
              "key": "asset_size",
              "value": 123,
              "value_type": "integer"
            }
          ],
          "common": {
            "standard": [
              {
                "key": "asset_size",
                "value": 123,
                "value_type": "integer"
              }
            ],
            "2d_spec": [
              {
                "key": "asset_size",
                "value": 123,
                "value_type": "integer"
              }
            ],
            "3d_spec": [
              {
                "key": "asset_size",
                "value": 123,
                "value_type": "integer"
              }
            ],
            "sound_spec": [
              {
                "key": "asset_size",
                "value": 123,
                "value_type": "integer"
              }
            ]
          }
        },
        "properties": {
          "collection": "Zombie",
          "properties_eyes": {
            "name": "eyes",
            "value": "big",
            "display_value": "Big Eyes"
          },
          "levels_speed": {
            "name": "speed",
            "value": 10,
            "max_value": 200,
            "display_type": "level"
          },
          "boosts_speed": {
            "name": "speed",
            "value": 5,
            "display_type": "boost_percentage"
          }
        }
      }
    ],
    "protocols": [
      "text"
    ],
    "socialMedia": [
      {
        "name": "facebook",
        "value": "https://facebook.com/"
      },
      {
        "name": "instagram",
        "value": "https://instagram.com/"
      }
    ]
  }
]

Returns App data

get

Path parameters

nameOrIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '..//v1/apps/{nameOrId}'

200

400

404

{
  "appId": "1aea9899-3f43-4ea6-852a-dddddbbc48c5",
  "patchkitAppId": "d4be5783-5373-4cca-ac96-1021277c3336",
  "name": "This is my app",
  "description": "Full app description",
  "team": "My team name",
  "teamId": "3895457a-94ff-41ae-8677-f7753bc5a81d",
  "categories": [
    "Action",
    "Adventure"
  ],
  "releaseDate": "25-05-2023",
  "platform": [
    {
      "platform": "xbox",
      "storeUrl": "https://store-url.com"
    },
    {
      "platform": "macos",
      "storeUrl": "https://store-url.com"
    }
  ],
  "status": "in development",
  "appStore": "https://app-store-link.com/my-app",
  "engine": "Unreal engine",
  "networks": [
    "bnb-chain"
  ],
  "website": "https://my-website.com",
  "gallery": [
    "text"
  ],
  "createdBy": "d4be5783-5373-4cca-ac96-1021277c3336",
  "favorites": 20,
  "wishes": 20,
  "createdAt": "2022-05-25T16:17:01.797Z",
  "updatedAt": "2022-05-25T16:17:01.797Z",
  "items": [
    {
      "itemId": "97c76a03-54b8-41c5-91b3-1e7f3c76ca16",
      "patchkitAppId": "d4be5783-5373-4cca-ac96-1021277c3336",
      "address": "0xa293d68684be29540838dc8a0222de0c43c6b5b4",
      "developmentStatus": "selected for development",
      "appId": "1aea9899-3f43-4ea6-852a-dddddbbc48c5",
      "teamId": "d69b15b2-2f41-4204-af19-34d683d04089",
      "_tokenId": 2137,
      "creationBlock": 21722028,
      "createdBy": "0xa293d68684be29540838dc8a0222de0c43c6b5b4",
      "creator": "0xa293d68684be29540838dc8a0222de0c43c6b5b4",
      "description": "Full token description",
      "image": "https://image.com/",
      "tokenName": "Token name",
      "_bucketHash": "def7cffa-5b05-4811-a265-1df98d2790b5",
      "filesSpec": {
        "item_experience": [
          {
            "key": "asset_size",
            "value": 123,
            "value_type": "integer"
          }
        ],
        "common": {
          "standard": [
            {
              "key": "asset_size",
              "value": 123,
              "value_type": "integer"
            }
          ],
          "2d_spec": [
            {
              "key": "asset_size",
              "value": 123,
              "value_type": "integer"
            }
          ],
          "3d_spec": [
            {
              "key": "asset_size",
              "value": 123,
              "value_type": "integer"
            }
          ],
          "sound_spec": [
            {
              "key": "asset_size",
              "value": 123,
              "value_type": "integer"
            }
          ]
        }
      },
      "properties": {
        "collection": "Zombie",
        "properties_eyes": {
          "name": "eyes",
          "value": "big",
          "display_value": "Big Eyes"
        },
        "levels_speed": {
          "name": "speed",
          "value": 10,
          "max_value": 200,
          "display_type": "level"
        },
        "boosts_speed": {
          "name": "speed",
          "value": 5,
          "display_type": "boost_percentage"
        }
      }
    }
  ],
  "protocols": [
    "text"
  ],
  "socialMedia": [
    {
      "name": "facebook",
      "value": "https://facebook.com/"
    },
    {
      "name": "instagram",
      "value": "https://instagram.com/"
    }
  ]
}

Returns App data

get

Path parameters

appKeystring · min: 40 · max: 60required

Example: 20989a02-f0c5-4a43-b3a1-1b8a4f6275b8

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '..//v1/apps/appkey/{appKey}'

200

400

404

{
  "appId": "1aea9899-3f43-4ea6-852a-dddddbbc48c5",
  "patchkitAppId": "d4be5783-5373-4cca-ac96-1021277c3336",
  "name": "This is my app",
  "description": "Full app description",
  "team": "My team name",
  "teamId": "3895457a-94ff-41ae-8677-f7753bc5a81d",
  "categories": [
    "Action",
    "Adventure"
  ],
  "releaseDate": "25-05-2023",
  "platform": [
    {
      "platform": "xbox",
      "storeUrl": "https://store-url.com"
    },
    {
      "platform": "macos",
      "storeUrl": "https://store-url.com"
    }
  ],
  "status": "in development",
  "appStore": "https://app-store-link.com/my-app",
  "engine": "Unreal engine",
  "networks": [
    "bnb-chain"
  ],
  "website": "https://my-website.com",
  "gallery": [
    "text"
  ],
  "createdBy": "d4be5783-5373-4cca-ac96-1021277c3336",
  "favorites": 20,
  "wishes": 20,
  "createdAt": "2022-05-25T16:17:01.797Z",
  "updatedAt": "2022-05-25T16:17:01.797Z",
  "items": [
    {
      "itemId": "97c76a03-54b8-41c5-91b3-1e7f3c76ca16",
      "patchkitAppId": "d4be5783-5373-4cca-ac96-1021277c3336",
      "address": "0xa293d68684be29540838dc8a0222de0c43c6b5b4",
      "developmentStatus": "selected for development",
      "appId": "1aea9899-3f43-4ea6-852a-dddddbbc48c5",
      "teamId": "d69b15b2-2f41-4204-af19-34d683d04089",
      "_tokenId": 2137,
      "creationBlock": 21722028,
      "createdBy": "0xa293d68684be29540838dc8a0222de0c43c6b5b4",
      "creator": "0xa293d68684be29540838dc8a0222de0c43c6b5b4",
      "description": "Full token description",
      "image": "https://image.com/",
      "tokenName": "Token name",
      "_bucketHash": "def7cffa-5b05-4811-a265-1df98d2790b5",
      "filesSpec": {
        "item_experience": [
          {
            "key": "asset_size",
            "value": 123,
            "value_type": "integer"
          }
        ],
        "common": {
          "standard": [
            {
              "key": "asset_size",
              "value": 123,
              "value_type": "integer"
            }
          ],
          "2d_spec": [
            {
              "key": "asset_size",
              "value": 123,
              "value_type": "integer"
            }
          ],
          "3d_spec": [
            {
              "key": "asset_size",
              "value": 123,
              "value_type": "integer"
            }
          ],
          "sound_spec": [
            {
              "key": "asset_size",
              "value": 123,
              "value_type": "integer"
            }
          ]
        }
      },
      "properties": {
        "collection": "Zombie",
        "properties_eyes": {
          "name": "eyes",
          "value": "big",
          "display_value": "Big Eyes"
        },
        "levels_speed": {
          "name": "speed",
          "value": 10,
          "max_value": 200,
          "display_type": "level"
        },
        "boosts_speed": {
          "name": "speed",
          "value": 5,
          "display_type": "boost_percentage"
        }
      }
    }
  ],
  "protocols": [
    "text"
  ],
  "socialMedia": [
    {
      "name": "facebook",
      "value": "https://facebook.com/"
    },
    {
      "name": "instagram",
      "value": "https://instagram.com/"
    }
  ]
}

Checks name availability

get

Path parameters

namestring · min: 2 · max: 100required

Example: This is my app

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '..//v1/apps/{name}/availability'

200

400

{
  "isAvailable": true
}

Returns App data

get

Path parameters

patchkitAppIdstringoptional

Example: 61dd53b0-e358-47fe-bad4-1f05f953600a

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '..//v1/apps/patchkit/{patchkitAppId}'

200

400

404

{
  "appId": "1aea9899-3f43-4ea6-852a-dddddbbc48c5",
  "patchkitAppId": "d4be5783-5373-4cca-ac96-1021277c3336",
  "name": "This is my app",
  "description": "Full app description",
  "team": "My team name",
  "teamId": "3895457a-94ff-41ae-8677-f7753bc5a81d",
  "categories": [
    "Action",
    "Adventure"
  ],
  "releaseDate": "25-05-2023",
  "platform": [
    {
      "platform": "xbox",
      "storeUrl": "https://store-url.com"
    },
    {
      "platform": "macos",
      "storeUrl": "https://store-url.com"
    }
  ],
  "status": "in development",
  "appStore": "https://app-store-link.com/my-app",
  "engine": "Unreal engine",
  "networks": [
    "bnb-chain"
  ],
  "website": "https://my-website.com",
  "gallery": [
    "text"
  ],
  "createdBy": "d4be5783-5373-4cca-ac96-1021277c3336",
  "favorites": 20,
  "wishes": 20,
  "createdAt": "2022-05-25T16:17:01.797Z",
  "updatedAt": "2022-05-25T16:17:01.797Z",
  "items": [
    {
      "itemId": "97c76a03-54b8-41c5-91b3-1e7f3c76ca16",
      "patchkitAppId": "d4be5783-5373-4cca-ac96-1021277c3336",
      "address": "0xa293d68684be29540838dc8a0222de0c43c6b5b4",
      "developmentStatus": "selected for development",
      "appId": "1aea9899-3f43-4ea6-852a-dddddbbc48c5",
      "teamId": "d69b15b2-2f41-4204-af19-34d683d04089",
      "_tokenId": 2137,
      "creationBlock": 21722028,
      "createdBy": "0xa293d68684be29540838dc8a0222de0c43c6b5b4",
      "creator": "0xa293d68684be29540838dc8a0222de0c43c6b5b4",
      "description": "Full token description",
      "image": "https://image.com/",
      "tokenName": "Token name",
      "_bucketHash": "def7cffa-5b05-4811-a265-1df98d2790b5",
      "filesSpec": {
        "item_experience": [
          {
            "key": "asset_size",
            "value": 123,
            "value_type": "integer"
          }
        ],
        "common": {
          "standard": [
            {
              "key": "asset_size",
              "value": 123,
              "value_type": "integer"
            }
          ],
          "2d_spec": [
            {
              "key": "asset_size",
              "value": 123,
              "value_type": "integer"
            }
          ],
          "3d_spec": [
            {
              "key": "asset_size",
              "value": 123,
              "value_type": "integer"
            }
          ],
          "sound_spec": [
            {
              "key": "asset_size",
              "value": 123,
              "value_type": "integer"
            }
          ]
        }
      },
      "properties": {
        "collection": "Zombie",
        "properties_eyes": {
          "name": "eyes",
          "value": "big",
          "display_value": "Big Eyes"
        },
        "levels_speed": {
          "name": "speed",
          "value": 10,
          "max_value": 200,
          "display_type": "level"
        },
        "boosts_speed": {
          "name": "speed",
          "value": 5,
          "display_type": "boost_percentage"
        }
      }
    }
  ],
  "protocols": [
    "text"
  ],
  "socialMedia": [
    {
      "name": "facebook",
      "value": "https://facebook.com/"
    },
    {
      "name": "instagram",
      "value": "https://instagram.com/"
    }
  ]
}

Returns a list of requested Applications

get

Path parameters

searchTextstringrequired

Query parameters

skipnumberoptional

Example: 2

limitnumber · min: 1optional

Example: 2

categoriesstring · enum[]optional

Example: ["Action","Adventure"]

networksstring · enum[]optional

Example: ["bnb-chain"]

platformsstring[]optional

teamIdsstring[]optional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '..//v1/apps-search/{searchText}'

200

400

404

{
  "results": [
    {
      "teamId": "1aea9899-3f43-4ea6-852a-dddddbbc48c5",
      "logo": "https://image.com/logo",
      "banner": "https://image.com/banner",
      "description": "Full team description",
      "name": "Team name",
      "website": "https://example-team-page.com",
      "createdBy": "d4be5783-5373-4cca-ac96-1021277c3336",
      "socialMedia": "https://facebook.com/my-profile",
      "createdAt": "2022-05-25T16:17:01.797Z",
      "updatedAt": "2022-05-25T16:17:01.797Z",
      "members": [
        {
          "address": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
          "userId": "abc123456"
        }
      ]
    }
  ],
  "count": 1
}

Returns App Items

get

Query parameters

skipnumberoptional

Example: 2

limitnumber · min: 1optional

Example: 2

appIdstring · min: 40 · max: 60optional

Example: 1aea9899-3f43-4ea6-852a-dddddbbc48c5

teamIdstring · min: 40 · max: 60optional

Example: 3895457a-94ff-41ae-8677-f7753bc5a81d

developmentStatusesstring · enum[]optional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '..//v1/items'

200

400

404

{
  "results": [
    {
      "itemId": "97c76a03-54b8-41c5-91b3-1e7f3c76ca16",
      "patchkitAppId": "d4be5783-5373-4cca-ac96-1021277c3336",
      "address": "0xa293d68684be29540838dc8a0222de0c43c6b5b4",
      "developmentStatus": "selected for development",
      "appId": "1aea9899-3f43-4ea6-852a-dddddbbc48c5",
      "teamId": "d69b15b2-2f41-4204-af19-34d683d04089",
      "_tokenId": 2137,
      "creationBlock": 21722028,
      "createdBy": "0xa293d68684be29540838dc8a0222de0c43c6b5b4",
      "creator": "0xa293d68684be29540838dc8a0222de0c43c6b5b4",
      "description": "Full token description",
      "image": "https://image.com/",
      "tokenName": "Token name",
      "_bucketHash": "def7cffa-5b05-4811-a265-1df98d2790b5",
      "filesSpec": {
        "item_experience": [
          {
            "key": "asset_size",
            "value": 123,
            "value_type": "integer"
          }
        ],
        "common": {
          "standard": [
            {
              "key": "asset_size",
              "value": 123,
              "value_type": "integer"
            }
          ],
          "2d_spec": [
            {
              "key": "asset_size",
              "value": 123,
              "value_type": "integer"
            }
          ],
          "3d_spec": [
            {
              "key": "asset_size",
              "value": 123,
              "value_type": "integer"
            }
          ],
          "sound_spec": [
            {
              "key": "asset_size",
              "value": 123,
              "value_type": "integer"
            }
          ]
        }
      },
      "properties": {
        "collection": "Zombie",
        "properties_eyes": {
          "name": "eyes",
          "value": "big",
          "display_value": "Big Eyes"
        },
        "levels_speed": {
          "name": "speed",
          "value": 10,
          "max_value": 200,
          "display_type": "level"
        },
        "boosts_speed": {
          "name": "speed",
          "value": 5,
          "display_type": "boost_percentage"
        }
      }
    }
  ],
  "count": 1
}

Returns App Item data

get

Path parameters

itemIdstring · min: 40 · max: 60required

Example: 97c76a03-54b8-41c5-91b3-1e7f3c76ca16

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '..//v1/items/{itemId}'

200

400

404

{}

Returns App Item data

get

Path parameters

addressstring · min: 35 · max: 55required

Token address

Example: 0xa293d68684be29540838dc8a0222de0c43c6b5b4

_tokenIdnumber · min: 1 · max: 10000000required

Example: 2137

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '..//v1/items/address/{address}/id/{_tokenId}'

200

400

404

{}

Remove an AppItem

delete

Authorizations

Path parameters

itemIdstring · min: 40 · max: 60required

Example: 97c76a03-54b8-41c5-91b3-1e7f3c76ca16

Header parameters

Authorizationstringrequired

asduf823hf-sa98ehf938rh

x-account-walletstringrequired

0xd1afbab5cacb45491ce002a6026c1401340eae6a

x-account-useridstringrequired

5a945f88-1de8cb-c6a1b4-1314ebac6bd1

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '..//v1/items/{itemId}' \
  --header 'Authorization: text' \
  --header 'x-account-wallet: text' \
  --header 'x-account-userid: text'

204

400

401

403

404

410

No body

Create App

post

Authorizations

Header parameters

Authorizationstringrequired

asduf823hf-sa98ehf938rh

x-account-walletstringrequired

0xd1afbab5cacb45491ce002a6026c1401340eae6a

x-account-useridstringrequired

5a945f88-1de8cb-c6a1b4-1314ebac6bd1

Body

namestring · min: 2 · max: 100required

Example: This is my app

teamstring · min: 2 · max: 100required

Example: My team name

teamIdstring · min: 40 · max: 60required

Example: 3895457a-94ff-41ae-8677-f7753bc5a81d

categoriesstring[]required

Example: ["Action","Adventure"]

releaseDatestringoptional

Example: 25-05-2023

platformobject[]required

Example: [{"platform":"xbox","storeUrl":"https://store-url.com"},{"platform":"macos","storeUrl":"https://store-url.com"}]

statusstring · enumrequired

Example: in development

Available options:

appStorestring · min: 2 · max: 1500optional

Example: https://app-store-link.com/my-app

enginestring · enumoptional

Example: Unreal engine

Available options:

networksstring[]required

Example: ["bnb-chain"]

websitestring · min: 2 · max: 1500optional

Example: https://my-website.com

gallerystring[]required

socialMediaobject[]optional

Example: [{"name":"facebook","value":"https://facebook.com/"},{"name":"instagram","value":"https://instagram.com/"}]

patchkitAppIdstringoptional

Example: 61dd53b0-e358-47fe-bad4-1f05f953600a

descriptionstring · max: 3000optional

Example: Full token description

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '..//v1/apps' \
  --header 'Authorization: text' \
  --header 'x-account-wallet: text' \
  --header 'x-account-userid: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "This is my app",
    "team": "My team name",
    "teamId": "3895457a-94ff-41ae-8677-f7753bc5a81d",
    "categories": [
      "Action",
      "Adventure"
    ],
    "releaseDate": "25-05-2023",
    "platform": [
      {
        "platform": "xbox",
        "storeUrl": "https://store-url.com"
      },
      {
        "platform": "macos",
        "storeUrl": "https://store-url.com"
      }
    ],
    "status": "in development",
    "appStore": "https://app-store-link.com/my-app",
    "engine": "Unreal engine",
    "networks": [
      "bnb-chain"
    ],
    "website": "https://my-website.com",
    "gallery": [
      "text"
    ],
    "socialMedia": [
      {
        "name": "facebook",
        "value": "https://facebook.com/"
      },
      {
        "name": "instagram",
        "value": "https://instagram.com/"
      }
    ],
    "patchkitAppId": "61dd53b0-e358-47fe-bad4-1f05f953600a",
    "description": "Full token description"
  }'

201

400

401

403

404

{
  "appId": "1aea9899-3f43-4ea6-852a-dddddbbc48c5",
  "patchkitAppId": "d4be5783-5373-4cca-ac96-1021277c3336",
  "name": "This is my app",
  "description": "Full app description",
  "team": "My team name",
  "teamId": "3895457a-94ff-41ae-8677-f7753bc5a81d",
  "categories": [
    "Action",
    "Adventure"
  ],
  "releaseDate": "25-05-2023",
  "platform": [
    {
      "platform": "xbox",
      "storeUrl": "https://store-url.com"
    },
    {
      "platform": "macos",
      "storeUrl": "https://store-url.com"
    }
  ],
  "status": "in development",
  "appStore": "https://app-store-link.com/my-app",
  "engine": "Unreal engine",
  "networks": [
    "bnb-chain"
  ],
  "website": "https://my-website.com",
  "gallery": [
    "text"
  ],
  "createdBy": "d4be5783-5373-4cca-ac96-1021277c3336",
  "favorites": 20,
  "wishes": 20,
  "createdAt": "2022-05-25T16:17:01.797Z",
  "updatedAt": "2022-05-25T16:17:01.797Z",
  "items": [
    {
      "itemId": "97c76a03-54b8-41c5-91b3-1e7f3c76ca16",
      "patchkitAppId": "d4be5783-5373-4cca-ac96-1021277c3336",
      "address": "0xa293d68684be29540838dc8a0222de0c43c6b5b4",
      "developmentStatus": "selected for development",
      "appId": "1aea9899-3f43-4ea6-852a-dddddbbc48c5",
      "teamId": "d69b15b2-2f41-4204-af19-34d683d04089",
      "_tokenId": 2137,
      "creationBlock": 21722028,
      "createdBy": "0xa293d68684be29540838dc8a0222de0c43c6b5b4",
      "creator": "0xa293d68684be29540838dc8a0222de0c43c6b5b4",
      "description": "Full token description",
      "image": "https://image.com/",
      "tokenName": "Token name",
      "_bucketHash": "def7cffa-5b05-4811-a265-1df98d2790b5",
      "filesSpec": {
        "item_experience": [
          {
            "key": "asset_size",
            "value": 123,
            "value_type": "integer"
          }
        ],
        "common": {
          "standard": [
            {
              "key": "asset_size",
              "value": 123,
              "value_type": "integer"
            }
          ],
          "2d_spec": [
            {
              "key": "asset_size",
              "value": 123,
              "value_type": "integer"
            }
          ],
          "3d_spec": [
            {
              "key": "asset_size",
              "value": 123,
              "value_type": "integer"
            }
          ],
          "sound_spec": [
            {
              "key": "asset_size",
              "value": 123,
              "value_type": "integer"
            }
          ]
        }
      },
      "properties": {
        "collection": "Zombie",
        "properties_eyes": {
          "name": "eyes",
          "value": "big",
          "display_value": "Big Eyes"
        },
        "levels_speed": {
          "name": "speed",
          "value": 10,
          "max_value": 200,
          "display_type": "level"
        },
        "boosts_speed": {
          "name": "speed",
          "value": 5,
          "display_type": "boost_percentage"
        }
      }
    }
  ],
  "protocols": [
    "text"
  ],
  "socialMedia": [
    {
      "name": "facebook",
      "value": "https://facebook.com/"
    },
    {
      "name": "instagram",
      "value": "https://instagram.com/"
    }
  ]
}

Update an App

patch

Authorizations

Header parameters

Authorizationstringrequired

asduf823hf-sa98ehf938rh

x-account-walletstringrequired

0xd1afbab5cacb45491ce002a6026c1401340eae6a

x-account-useridstringrequired

5a945f88-1de8cb-c6a1b4-1314ebac6bd1

Body

namestring · min: 2 · max: 100optional

Example: This is my app

teamstring · min: 2 · max: 100optional

Example: My team name

teamIdstring · min: 40 · max: 60optional

Example: 3895457a-94ff-41ae-8677-f7753bc5a81d

categoriesstring[]optional

Example: ["Action","Adventure"]

releaseDatestringoptional

Example: 25-05-2023

platformobject[]optional

Example: [{"platform":"xbox","storeUrl":"https://store-url.com"},{"platform":"macos","storeUrl":"https://store-url.com"}]

statusstring · enumoptional

Example: in development

Available options:

appStorestring · min: 2 · max: 1500optional

Example: https://app-store-link.com/my-app

enginestring · enumoptional

Example: Unreal engine

Available options:

networksstring[]optional

Example: ["bnb-chain"]

websitestring · min: 2 · max: 1500optional

Example: https://my-website.com

gallerystring[]optional

socialMediaobject[]optional

Example: [{"name":"facebook","value":"https://facebook.com/"},{"name":"instagram","value":"https://instagram.com/"}]

patchkitAppIdstringoptional

Example: 61dd53b0-e358-47fe-bad4-1f05f953600a

descriptionstring · max: 3000optional

Example: Full token description

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url '..//v1/apps/{appId}' \
  --header 'Authorization: text' \
  --header 'x-account-wallet: text' \
  --header 'x-account-userid: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "This is my app",
    "team": "My team name",
    "teamId": "3895457a-94ff-41ae-8677-f7753bc5a81d",
    "categories": [
      "Action",
      "Adventure"
    ],
    "releaseDate": "25-05-2023",
    "platform": [
      {
        "platform": "xbox",
        "storeUrl": "https://store-url.com"
      },
      {
        "platform": "macos",
        "storeUrl": "https://store-url.com"
      }
    ],
    "status": "in development",
    "appStore": "https://app-store-link.com/my-app",
    "engine": "Unreal engine",
    "networks": [
      "bnb-chain"
    ],
    "website": "https://my-website.com",
    "gallery": [
      "text"
    ],
    "socialMedia": [
      {
        "name": "facebook",
        "value": "https://facebook.com/"
      },
      {
        "name": "instagram",
        "value": "https://instagram.com/"
      }
    ],
    "patchkitAppId": "61dd53b0-e358-47fe-bad4-1f05f953600a",
    "description": "Full token description"
  }'

201

400

401

403

404

{
  "appId": "1aea9899-3f43-4ea6-852a-dddddbbc48c5",
  "patchkitAppId": "d4be5783-5373-4cca-ac96-1021277c3336",
  "name": "This is my app",
  "description": "Full app description",
  "team": "My team name",
  "teamId": "3895457a-94ff-41ae-8677-f7753bc5a81d",
  "categories": [
    "Action",
    "Adventure"
  ],
  "releaseDate": "25-05-2023",
  "platform": [
    {
      "platform": "xbox",
      "storeUrl": "https://store-url.com"
    },
    {
      "platform": "macos",
      "storeUrl": "https://store-url.com"
    }
  ],
  "status": "in development",
  "appStore": "https://app-store-link.com/my-app",
  "engine": "Unreal engine",
  "networks": [
    "bnb-chain"
  ],
  "website": "https://my-website.com",
  "gallery": [
    "text"
  ],
  "createdBy": "d4be5783-5373-4cca-ac96-1021277c3336",
  "favorites": 20,
  "wishes": 20,
  "createdAt": "2022-05-25T16:17:01.797Z",
  "updatedAt": "2022-05-25T16:17:01.797Z",
  "items": [
    {
      "itemId": "97c76a03-54b8-41c5-91b3-1e7f3c76ca16",
      "patchkitAppId": "d4be5783-5373-4cca-ac96-1021277c3336",
      "address": "0xa293d68684be29540838dc8a0222de0c43c6b5b4",
      "developmentStatus": "selected for development",
      "appId": "1aea9899-3f43-4ea6-852a-dddddbbc48c5",
      "teamId": "d69b15b2-2f41-4204-af19-34d683d04089",
      "_tokenId": 2137,
      "creationBlock": 21722028,
      "createdBy": "0xa293d68684be29540838dc8a0222de0c43c6b5b4",
      "creator": "0xa293d68684be29540838dc8a0222de0c43c6b5b4",
      "description": "Full token description",
      "image": "https://image.com/",
      "tokenName": "Token name",
      "_bucketHash": "def7cffa-5b05-4811-a265-1df98d2790b5",
      "filesSpec": {
        "item_experience": [
          {
            "key": "asset_size",
            "value": 123,
            "value_type": "integer"
          }
        ],
        "common": {
          "standard": [
            {
              "key": "asset_size",
              "value": 123,
              "value_type": "integer"
            }
          ],
          "2d_spec": [
            {
              "key": "asset_size",
              "value": 123,
              "value_type": "integer"
            }
          ],
          "3d_spec": [
            {
              "key": "asset_size",
              "value": 123,
              "value_type": "integer"
            }
          ],
          "sound_spec": [
            {
              "key": "asset_size",
              "value": 123,
              "value_type": "integer"
            }
          ]
        }
      },
      "properties": {
        "collection": "Zombie",
        "properties_eyes": {
          "name": "eyes",
          "value": "big",
          "display_value": "Big Eyes"
        },
        "levels_speed": {
          "name": "speed",
          "value": 10,
          "max_value": 200,
          "display_type": "level"
        },
        "boosts_speed": {
          "name": "speed",
          "value": 5,
          "display_type": "boost_percentage"
        }
      }
    }
  ],
  "protocols": [
    "text"
  ],
  "socialMedia": [
    {
      "name": "facebook",
      "value": "https://facebook.com/"
    },
    {
      "name": "instagram",
      "value": "https://instagram.com/"
    }
  ]
}

Response might contain additional property "appKey" if there are items assigned to the application

Create Item(s)

post

Authorizations

Header parameters

Authorizationstringrequired

asduf823hf-sa98ehf938rh

x-account-walletstringrequired

0xd1afbab5cacb45491ce002a6026c1401340eae6a

x-account-useridstringrequired

5a945f88-1de8cb-c6a1b4-1314ebac6bd1

Body

itemsobject[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '..//v1/items' \
  --header 'Authorization: text' \
  --header 'x-account-wallet: text' \
  --header 'x-account-userid: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "items": [
      {
        "appId": "1aea9899-3f43-4ea6-852a-dddddbbc48c5",
        "teamId": "3895457a-94ff-41ae-8677-f7753bc5a81d",
        "createdBy": "d4be5783-5373-4cca-ac96-1021277c3336",
        "address": "0xa293d68684be29540838dc8a0222de0c43c6b5b4",
        "developmentStatus": "selected for development",
        "_tokenId": 2137,
        "creationBlock": 21722028,
        "description": "Full token description",
        "image": "https://image.com/",
        "tokenName": "asdfasf",
        "_bucketHash": "def7cffa-5b05-4811-a265-1df98d2790b5",
        "filesSpec": {
          "item_experience": [
            {
              "key": "asset_size",
              "value": 123,
              "value_type": "integer"
            }
          ],
          "common": {
            "standard": [
              {
                "key": "asset_size",
                "value": 123,
                "value_type": "integer"
              }
            ],
            "2d_spec": [
              {
                "key": "asset_size",
                "value": 123,
                "value_type": "integer"
              }
            ],
            "3d_spec": [
              {
                "key": "asset_size",
                "value": 123,
                "value_type": "integer"
              }
            ],
            "sound_spec": [
              {
                "key": "asset_size",
                "value": 123,
                "value_type": "integer"
              }
            ]
          }
        },
        "properties": {
          "collection": "Zombie",
          "properties_eyes": {
            "name": "eyes",
            "value": "big",
            "display_value": "Big Eyes"
          },
          "levels_speed": {
            "name": "speed",
            "value": 10,
            "max_value": 200,
            "display_type": "level"
          },
          "boosts_speed": {
            "name": "speed",
            "value": 5,
            "display_type": "boost_percentage"
          }
        }
      }
    ]
  }'

201

400

401

403

404

[
  {}
]

Update an App

patch

Authorizations

Path parameters

itemIdstring · min: 40 · max: 60required

Example: 97c76a03-54b8-41c5-91b3-1e7f3c76ca16

Header parameters

Authorizationstringrequired

asduf823hf-sa98ehf938rh

x-account-walletstringrequired

0xd1afbab5cacb45491ce002a6026c1401340eae6a

x-account-useridstringrequired

5a945f88-1de8cb-c6a1b4-1314ebac6bd1

Body

developmentStatusstring · enumrequired

Available options:

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url '..//v1/items/{itemId}' \
  --header 'Authorization: text' \
  --header 'x-account-wallet: text' \
  --header 'x-account-userid: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "developmentStatus": "selected for development"
  }'

201

400

401

403

404

{}

Swagger docs link:

Item

Swagger docs link:

Item

Returns a list of Applications

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Returns App data

Returns App data

Returns App data

Checks name availability

Returns App data

Returns a list of requested Applications

Show child attributes

Show child attributes

Returns App Items

Show child attributes

Returns App Item data

Returns App Item data

Remove an AppItem

Create App

Update an App

Create Item(s)

Show child attributes

Update an App