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.

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

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: 100RequiredExample: This is my app
teamstring · min: 2 · max: 100RequiredExample: My team name
teamIdstring · min: 40 · max: 60RequiredExample: 3895457a-94ff-41ae-8677-f7753bc5a81d
categoriesstring[]RequiredExample: ["Action","Adventure"]
releaseDatestringOptionalExample: 25-05-2023
platformobject[]RequiredExample: [{"platform":"xbox","storeUrl":"https://store-url.com"},{"platform":"macos","storeUrl":"https://store-url.com"}]
statusstring · enumRequiredExample: in developmentPossible values:
appStorestring · min: 2 · max: 1500OptionalExample: https://app-store-link.com/my-app
enginestring · enumOptionalExample: Unreal enginePossible values:
networksstring[]RequiredExample: ["bnb-chain"]
websitestring · min: 2 · max: 1500OptionalExample: https://my-website.com
gallerystring[]Required
socialMediaobject[]OptionalExample: [{"name":"facebook","value":"https://facebook.com/"},{"name":"instagram","value":"https://instagram.com/"}]
patchkitAppIdstringOptionalExample: 61dd53b0-e358-47fe-bad4-1f05f953600a
descriptionstring · max: 3000OptionalExample: Full token description
Responses
201Success
application/json
post
POST /apps HTTP/1.1
Host: v1
Authorization: text
x-account-wallet: text
x-account-userid: text
Content-Type: application/json
Accept: */*
Content-Length: 675

{
  "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"
}
{
  "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/"
    }
  ]
}
get
Responses
200Success
application/json
Responsestring
get
GET / HTTP/1.1
Host: health
Accept: */*
200Success
text

Returns a list of Applications

get
Query parameters
skipnumberOptionalExample: 2
limitnumber · min: 1OptionalExample: 2
namestring · min: 2 · max: 100OptionalExample: This is my app
teamIdstring · min: 40 · max: 60OptionalExample: 3895457a-94ff-41ae-8677-f7753bc5a81d
appStorestring · min: 2 · max: 1500OptionalExample: https://app-store-link.com/my-app
websitestring · min: 2 · max: 1500OptionalExample: 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: 10000000OptionalExample: 2137
appIdsstring[]Optional
_itemsbooleanOptional
teamIdsstring[]Optional
platformsstring[]Optional
downloadablebooleanOptional
internalbooleanOptional
patchkitAppIdsstring[]Optional
protocolsstring[]Optional
leaderboardbooleanOptional
Responses
200Success
application/json
get
GET /apps HTTP/1.1
Host: v1
Accept: */*
{
  "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
200Success
application/json
get
GET /apps/rich HTTP/1.1
Host: v1
Authorization: text
x-account-wallet: text
x-account-userid: text
Accept: */*
[
  {
    "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
200Success
application/json
get
GET /apps/{nameOrId} HTTP/1.1
Host: v1
Accept: */*
{
  "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: 60RequiredExample: 20989a02-f0c5-4a43-b3a1-1b8a4f6275b8
Responses
200Success
application/json
get
GET /apps/appkey/{appKey} HTTP/1.1
Host: v1
Accept: */*
{
  "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: 100RequiredExample: This is my app
Responses
200Success
application/json
get
GET /apps/{name}/availability HTTP/1.1
Host: v1
Accept: */*
{
  "isAvailable": true
}

Returns App data

get
Path parameters
patchkitAppIdstringOptionalExample: 61dd53b0-e358-47fe-bad4-1f05f953600a
Responses
200Success
application/json
get
GET /apps/patchkit/{patchkitAppId} HTTP/1.1
Host: v1
Accept: */*
{
  "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
skipnumberOptionalExample: 2
limitnumber · min: 1OptionalExample: 2
platformsstring[]Optional
teamIdsstring[]Optional
Responses
200Success
application/json
get
GET /apps-search/{searchText} HTTP/1.1
Host: v1
Accept: */*
{
  "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
}

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: 100OptionalExample: This is my app
teamstring · min: 2 · max: 100OptionalExample: My team name
teamIdstring · min: 40 · max: 60OptionalExample: 3895457a-94ff-41ae-8677-f7753bc5a81d
categoriesstring[]OptionalExample: ["Action","Adventure"]
releaseDatestringOptionalExample: 25-05-2023
platformobject[]OptionalExample: [{"platform":"xbox","storeUrl":"https://store-url.com"},{"platform":"macos","storeUrl":"https://store-url.com"}]
statusstring · enumOptionalExample: in developmentPossible values:
appStorestring · min: 2 · max: 1500OptionalExample: https://app-store-link.com/my-app
enginestring · enumOptionalExample: Unreal enginePossible values:
networksstring[]OptionalExample: ["bnb-chain"]
websitestring · min: 2 · max: 1500OptionalExample: https://my-website.com
gallerystring[]Optional
socialMediaobject[]OptionalExample: [{"name":"facebook","value":"https://facebook.com/"},{"name":"instagram","value":"https://instagram.com/"}]
patchkitAppIdstringOptionalExample: 61dd53b0-e358-47fe-bad4-1f05f953600a
descriptionstring · max: 3000OptionalExample: Full token description
Responses
201
Response might contain additional property "appKey" if there are items assigned to the application
application/json
Responseone of
or
patch
PATCH /apps/{appId} HTTP/1.1
Host: v1
Authorization: text
x-account-wallet: text
x-account-userid: text
Content-Type: application/json
Accept: */*
Content-Length: 675

{
  "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"
}
{
  "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/"
    }
  ]
}

Item

Create Item(s)

post
Authorizations
Header parameters
AuthorizationstringRequired

asduf823hf-sa98ehf938rh

x-account-walletstringRequired

0xd1afbab5cacb45491ce002a6026c1401340eae6a

x-account-useridstringRequired

5a945f88-1de8cb-c6a1b4-1314ebac6bd1

Body
Responses
201Success
application/json
Responseobject[]
post
POST /items HTTP/1.1
Host: v1
Authorization: text
x-account-wallet: text
x-account-userid: text
Content-Type: application/json
Accept: */*
Content-Length: 1092

{
  "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"
        }
      }
    }
  ]
}
[
  {}
]
get
Responses
200Success
application/json
Responsestring
get
GET / HTTP/1.1
Host: health
Accept: */*
200Success
text

Returns App Items

get
Query parameters
skipnumberOptionalExample: 2
limitnumber · min: 1OptionalExample: 2
appIdstring · min: 40 · max: 60OptionalExample: 1aea9899-3f43-4ea6-852a-dddddbbc48c5
teamIdstring · min: 40 · max: 60OptionalExample: 3895457a-94ff-41ae-8677-f7753bc5a81d
Responses
200Success
application/json
get
GET /items HTTP/1.1
Host: v1
Accept: */*
{
  "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: 60RequiredExample: 97c76a03-54b8-41c5-91b3-1e7f3c76ca16
Responses
200Success
application/json
Responseobject
get
GET /items/{itemId} HTTP/1.1
Host: v1
Accept: */*
{}

Returns App Item data

get
Path parameters
addressstring · min: 35 · max: 55Required

Token address

Example: 0xa293d68684be29540838dc8a0222de0c43c6b5b4
_tokenIdnumber · min: 1 · max: 10000000RequiredExample: 2137
Responses
200Success
application/json
Responseobject
get
GET /items/address/{address}/id/{_tokenId} HTTP/1.1
Host: v1
Accept: */*
{}

Update an App

patch
Authorizations
Path parameters
itemIdstring · min: 40 · max: 60RequiredExample: 97c76a03-54b8-41c5-91b3-1e7f3c76ca16
Header parameters
AuthorizationstringRequired

asduf823hf-sa98ehf938rh

x-account-walletstringRequired

0xd1afbab5cacb45491ce002a6026c1401340eae6a

x-account-useridstringRequired

5a945f88-1de8cb-c6a1b4-1314ebac6bd1

Body
developmentStatusstring · enumRequiredPossible values:
Responses
201Success
application/json
Responseobject
patch
PATCH /items/{itemId} HTTP/1.1
Host: v1
Authorization: text
x-account-wallet: text
x-account-userid: text
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "developmentStatus": "selected for development"
}
{}

Remove an AppItem

delete
Authorizations
Path parameters
itemIdstring · min: 40 · max: 60RequiredExample: 97c76a03-54b8-41c5-91b3-1e7f3c76ca16
Header parameters
AuthorizationstringRequired

asduf823hf-sa98ehf938rh

x-account-walletstringRequired

0xd1afbab5cacb45491ce002a6026c1401340eae6a

x-account-useridstringRequired

5a945f88-1de8cb-c6a1b4-1314ebac6bd1

Responses
204Success
delete
DELETE /items/{itemId} HTTP/1.1
Host: v1
Authorization: text
x-account-wallet: text
x-account-userid: text
Accept: */*

No content

Last updated