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

Create App

POST..//v1/apps

Authorization

Authorization

Header parameters

Body

application/json

name*string

Example: "This is my app"

team*string

Example: "My team name"

teamId*string

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

categories*array of string

releaseDatestring

Example: "25-05-2023"

platform*array of object

status*enum

Example: "in development"

in developmentreleased

appStorestring

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

engineenum

Example: "Unreal engine"

UnityUnreal engineRED engineOtherElympics

networks*array of string

websitestring

Example: "https://my-website.com"

gallery*array of string

socialMediaarray of object

patchkitAppIdstring

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

descriptionstring

Example: "Full token description"

Response

201400401403404

Body

application/json

appId*string

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

patchkitAppIdstring

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

name*string

Example: "This is my app"

descriptionstring

Example: "Full app description"

team*string

Example: "My team name"

teamId*string

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

categories*array of string

releaseDatestring

Example: "25-05-2023"

platform*array of object

status*string

Example: "in development"

appStorestring

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

enginestring

Example: "Unreal engine"

networks*array of string

websitestring

Example: "https://my-website.com"

gallery*array of string

createdBy*string

User ID

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

favorites*number

Example: 20

wishes*number

Example: 20

createdAt*string (date-time)

Example: "2022-05-25T16:17:01.797Z"

updatedAt*string (date-time)

Example: "2022-05-25T16:17:01.797Z"

items*array of AppItem (object)

protocols*array of string

socialMediaarray of object

Request

JavaScriptCurlPython

const response = await fetch('..//v1/apps', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "x-account-wallet": "text",
      "x-account-userid": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "This is my app",
      "team": "My team name",
      "teamId": "3895457a-94ff-41ae-8677-f7753bc5a81d",
      "categories": [
        "Action",
        "Adventure"
      ],
      "platform": [
        {
          "platform": "xbox",
          "storeUrl": "https://store-url.com"
        },
        {
          "platform": "macos",
          "storeUrl": "https://store-url.com"
        }
      ],
      "status": "in development",
      "networks": [
        "bnb-chain"
      ],
      "gallery": [
        "text"
      ]
    }),
});
const data = await response.json();

Response

201400401403404

{
  "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..//health

Response

200

Body

application/json

string

Request

JavaScriptCurlPython

const response = await fetch('..//health', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

text

Returns a list of Applications

GET..//v1/apps

Query parameters

Response

200400404

Body

application/json

results*array of ApiApplicationResponse (object)

count*number

Request

JavaScriptCurlPython

const response = await fetch('..//v1/apps', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400404

{
  "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": 0
}

Returns App data

GET..//v1/apps/rich

Authorization

Authorization

Query parameters

Header parameters

Response

200400401403404

Body

application/json

appId*string

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

patchkitAppIdstring

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

appKey*string

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

name*string

Example: "This is my app"

descriptionstring

Example: "Full app description"

team*string

Example: "My team name"

teamId*string

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

categories*array of string

releaseDatestring

Example: "25-05-2023"

platform*array of object

status*string

Example: "in development"

appStorestring

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

enginestring

Example: "Unreal engine"

networks*array of string

websitestring

Example: "https://my-website.com"

gallery*array of string

createdBy*string

User ID

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

favorites*number

Example: 20

wishes*number

Example: 20

createdAt*string (date-time)

Example: "2022-05-25T16:17:01.797Z"

updatedAt*string (date-time)

Example: "2022-05-25T16:17:01.797Z"

items*array of AppItem (object)

protocols*array of string

socialMediaarray of object

Request

JavaScriptCurlPython

const response = await fetch('..//v1/apps/rich', {
    method: 'GET',
    headers: {
      "Authorization": "text",
      "x-account-wallet": "text",
      "x-account-userid": "text"
    },
});
const data = await response.json();

Response

200400401403404

[
  {
    "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..//v1/apps/{nameOrId}

Path parameters

nameOrId*string

Response

200400404

Body

application/json

appId*string

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

patchkitAppIdstring

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

name*string

Example: "This is my app"

descriptionstring

Example: "Full app description"

team*string

Example: "My team name"

teamId*string

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

categories*array of string

releaseDatestring

Example: "25-05-2023"

platform*array of object

status*string

Example: "in development"

appStorestring

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

enginestring

Example: "Unreal engine"

networks*array of string

websitestring

Example: "https://my-website.com"

gallery*array of string

createdBy*string

User ID

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

favorites*number

Example: 20

wishes*number

Example: 20

createdAt*string (date-time)

Example: "2022-05-25T16:17:01.797Z"

updatedAt*string (date-time)

Example: "2022-05-25T16:17:01.797Z"

items*array of AppItem (object)

protocols*array of string

socialMediaarray of object

Request

JavaScriptCurlPython

const response = await fetch('..//v1/apps/{nameOrId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400404

{
  "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..//v1/apps/appkey/{appKey}

Path parameters

appKey*string

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

Response

200400404

Body

application/json

appId*string

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

patchkitAppIdstring

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

name*string

Example: "This is my app"

descriptionstring

Example: "Full app description"

team*string

Example: "My team name"

teamId*string

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

categories*array of string

releaseDatestring

Example: "25-05-2023"

platform*array of object

status*string

Example: "in development"

appStorestring

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

enginestring

Example: "Unreal engine"

networks*array of string

websitestring

Example: "https://my-website.com"

gallery*array of string

createdBy*string

User ID

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

favorites*number

Example: 20

wishes*number

Example: 20

createdAt*string (date-time)

Example: "2022-05-25T16:17:01.797Z"

updatedAt*string (date-time)

Example: "2022-05-25T16:17:01.797Z"

items*array of AppItem (object)

protocols*array of string

socialMediaarray of object

Request

JavaScriptCurlPython

const response = await fetch('..//v1/apps/appkey/{appKey}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400404

{
  "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..//v1/apps/{name}/availability

Path parameters

name*string

Example: "This is my app"

Response

200400

Body

application/json

isAvailable*boolean

Request

JavaScriptCurlPython

const response = await fetch('..//v1/apps/{name}/availability', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "isAvailable": false
}

Returns App data

GET..//v1/apps/patchkit/{patchkitAppId}

Path parameters

patchkitAppIdstring

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

Response

200400404

Body

application/json

appId*string

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

patchkitAppIdstring

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

name*string

Example: "This is my app"

descriptionstring

Example: "Full app description"

team*string

Example: "My team name"

teamId*string

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

categories*array of string

releaseDatestring

Example: "25-05-2023"

platform*array of object

status*string

Example: "in development"

appStorestring

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

enginestring

Example: "Unreal engine"

networks*array of string

websitestring

Example: "https://my-website.com"

gallery*array of string

createdBy*string

User ID

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

favorites*number

Example: 20

wishes*number

Example: 20

createdAt*string (date-time)

Example: "2022-05-25T16:17:01.797Z"

updatedAt*string (date-time)

Example: "2022-05-25T16:17:01.797Z"

items*array of AppItem (object)

protocols*array of string

socialMediaarray of object

Request

JavaScriptCurlPython

const response = await fetch('..//v1/apps/patchkit/{patchkitAppId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400404

{
  "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..//v1/apps-search/{searchText}

Path parameters

searchText*string

Query parameters

Response

200400404

Body

application/json

results*array of Team (object)

count*number

Request

JavaScriptCurlPython

const response = await fetch('..//v1/apps-search/{searchText}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400404

{
  "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": 0
}

Update an App

PATCH..//v1/apps/{appId}

Authorization

Authorization

Header parameters

Body

application/json

namestring

Example: "This is my app"

teamstring

Example: "My team name"

teamIdstring

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

categoriesarray of string

releaseDatestring

Example: "25-05-2023"

platformarray of object

statusenum

Example: "in development"

in developmentreleased

appStorestring

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

engineenum

Example: "Unreal engine"

UnityUnreal engineRED engineOtherElympics

networksarray of string

websitestring

Example: "https://my-website.com"

galleryarray of string

socialMediaarray of object

patchkitAppIdstring

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

descriptionstring

Example: "Full token description"

Response

201400401403404

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

Body

application/json

one of

ApiApplicationResponse (object)Application (object)

Request

JavaScriptCurlPython

const response = await fetch('..//v1/apps/{appId}', {
    method: 'PATCH',
    headers: {
      "Authorization": "text",
      "x-account-wallet": "text",
      "x-account-userid": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201400401403404

{
  "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..//v1/items

Authorization

Authorization

Header parameters

Body

application/json

items*array of CreateAppItemDto (object)

Response

201400401403404

Body

application/json

array of AppItemSchema (object)

Request

JavaScriptCurlPython

const response = await fetch('..//v1/items', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "x-account-wallet": "text",
      "x-account-userid": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "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
        }
      ]
    }),
});
const data = await response.json();

Response

201400401403404

[
  {}
]

GET..//health

Response

200

Body

application/json

string

Request

JavaScriptCurlPython

const response = await fetch('..//health', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

text

Returns App Items

GET..//v1/items

Query parameters

Response

200400404

Body

application/json

results*array of AppItem (object)

count*number

Request

JavaScriptCurlPython

const response = await fetch('..//v1/items', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400404

{
  "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": 0
}

Returns App Item data

GET..//v1/items/{itemId}

Path parameters

itemId*string

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

Response

200400404

Body

application/json

AppItemSchema (object)

Request

JavaScriptCurlPython

const response = await fetch('..//v1/items/{itemId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400404

{}

Returns App Item data

GET..//v1/items/address/{address}/id/{_tokenId}

Path parameters

address*string

Token address

Example: "0xa293d68684be29540838dc8a0222de0c43c6b5b4"

_tokenId*number

Example: 2137

Response

200400404

Body

application/json

AppItemSchema (object)

Request

JavaScriptCurlPython

const response = await fetch('..//v1/items/address/{address}/id/{_tokenId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400404

{}

Update an App

PATCH..//v1/items/{itemId}

Authorization

Authorization

Path parameters

itemId*string

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

Header parameters

Body

application/json

developmentStatus*enum

selected for developmentin progressimplemented

Response

201400401403404

Body

application/json

AppItemSchema (object)

Request

JavaScriptCurlPython

const response = await fetch('..//v1/items/{itemId}', {
    method: 'PATCH',
    headers: {
      "Authorization": "text",
      "x-account-wallet": "text",
      "x-account-userid": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "developmentStatus": "selected for development"
    }),
});
const data = await response.json();

Response

201400401403404

{}

Remove an AppItem

DELETE..//v1/items/{itemId}

Authorization

Authorization

Path parameters

itemId*string

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

Header parameters

Response

204400401403404410

Request

JavaScriptCurlPython

const response = await fetch('..//v1/items/{itemId}', {
    method: 'DELETE',
    headers: {
      "Authorization": "text",
      "x-account-wallet": "text",
      "x-account-userid": "text"
    },
});
const data = await response.json();

Response

400401403404

{
  "statusCode": 400,
  "messages": [
    "Name must be in string format",
    "Name must be minimum 2 characters long"
  ],
  "error": "Bad Request"
}