Nft service

The NFT API provides endpoints for managing and retrieving NFTs (Non-Fungible Tokens). You can retrieve a list of requested NFTs, retrieve specific NFTs by address and ID, and access user-specific NFTs such as created, mobile, liked, and wished tokens.

Swagger docs link:

https://api.metaproprotocol.com/ms/nft/docs/#/

NFT

---

Returns a Nft

GET..//v1/tokens/{address}/id/{id}

Path parameters

address*string

Example: "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377"

id*number

Response

200400404

Body

application/json

address*string

Example: "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377"

createdBy*string

Example: "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377"

contractAddress*string

Example: "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377"

standard*enum

erc1155erc721

protocol*string

network*enum

bnb-chainethereumpolygonbase

chainId*number

Example: 56

creationBlock*number

Example: 18504697

version*number

Example: 2

isListed*boolean

Example: true

isAsset*boolean

Example: true

createdAt*string (date-time)

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

token*NftToken (object)

Request

JavaScriptCurlPython

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

Response

200400404

{
  "address": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
  "createdBy": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
  "contractAddress": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
  "standard": "erc1155",
  "protocol": "text",
  "network": "bnb-chain",
  "chainId": 56,
  "creationBlock": 18504697,
  "version": 2,
  "isListed": true,
  "isAsset": true,
  "createdAt": "2022-05-25T16:17:01.797Z",
  "token": {
    "address": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
    "owner": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
    "createdBy": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
    "initialOwner": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
    "_bucketHash": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
    "transactionHash": "0xad2d281e499c6349ac590eb77695852b2ccbc9e5251c3f0531ad6075c7e530b6",
    "_tokenId": 1,
    "creationBlock": 21592868,
    "_quantity": 20,
    "image": "http://image.com",
    "description": "My description",
    "tokenName": "Best token name",
    "burn": false,
    "symbol": "NFT-Symbol",
    "properties": {
      "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"
          }
        ]
      }
    },
    "favorites": 20,
    "wishes": 20,
    "isBlacklisted": false,
    "extraFiles": [
      "https://extra-file.com/file1"
    ],
    "minifiedImage": "https://extra-file.com/file1",
    "standard": "erc1155",
    "protocol": "text",
    "network": "bnb-chain",
    "isAsset": true,
    "createdAt": "2022-05-25T16:17:01.797Z",
    "updatedAt": "2022-05-25T16:17:01.797Z"
  }
}

User NFTs

---

Internal NFTs

The Internal API offers endpoints for internal purposes related to NFTs. You can retrieve a list of requested NFTs with rich data and access specific NFTs by address and ID with rich data.

---

Returns a list of requested Nft

GET..//v1/internal/tokens/rich

Authorization

Authorization

Query parameters

Header parameters

Response

200400401403404

Body

application/json

results*array of Nft (object)

count*number

Request

JavaScriptCurlPython

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

Response

200400401403404

{
  "results": [
    {
      "address": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
      "createdBy": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
      "contractAddress": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
      "standard": "erc1155",
      "protocol": "text",
      "network": "bnb-chain",
      "chainId": 56,
      "creationBlock": 18504697,
      "version": 2,
      "isListed": true,
      "isAsset": true,
      "createdAt": "2022-05-25T16:17:01.797Z",
      "token": {
        "address": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
        "owner": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
        "createdBy": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
        "initialOwner": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
        "_bucketHash": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
        "transactionHash": "0xad2d281e499c6349ac590eb77695852b2ccbc9e5251c3f0531ad6075c7e530b6",
        "_tokenId": 1,
        "creationBlock": 21592868,
        "_quantity": 20,
        "image": "http://image.com",
        "description": "My description",
        "tokenName": "Best token name",
        "burn": false,
        "symbol": "NFT-Symbol",
        "properties": {
          "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"
              }
            ]
          }
        },
        "favorites": 20,
        "wishes": 20,
        "isBlacklisted": false,
        "extraFiles": [
          "https://extra-file.com/file1"
        ],
        "minifiedImage": "https://extra-file.com/file1",
        "standard": "erc1155",
        "protocol": "text",
        "network": "bnb-chain",
        "isAsset": true,
        "createdAt": "2022-05-25T16:17:01.797Z",
        "updatedAt": "2022-05-25T16:17:01.797Z"
      }
    }
  ],
  "count": 0
}

Returns a Nft

GET..//v1/internal/tokens/{address}/id/{id}/rich

Authorization

Authorization

Path parameters

address*string

Example: "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377"

id*number

Header parameters

Response

200400401403404

Body

application/json

address*string

Example: "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377"

createdBy*string

Example: "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377"

contractAddress*string

Example: "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377"

standard*enum

erc1155erc721

protocol*string

network*enum

bnb-chainethereumpolygonbase

chainId*number

Example: 56

creationBlock*number

Example: 18504697

version*number

Example: 2

isListed*boolean

Example: true

isAsset*boolean

Example: true

createdAt*string (date-time)

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

token*NftToken (object)

Request

JavaScriptCurlPython

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

Response

200400401403404

{
  "address": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
  "createdBy": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
  "contractAddress": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
  "standard": "erc1155",
  "protocol": "text",
  "network": "bnb-chain",
  "chainId": 56,
  "creationBlock": 18504697,
  "version": 2,
  "isListed": true,
  "isAsset": true,
  "createdAt": "2022-05-25T16:17:01.797Z",
  "token": {
    "address": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
    "owner": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
    "createdBy": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
    "initialOwner": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
    "_bucketHash": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
    "transactionHash": "0xad2d281e499c6349ac590eb77695852b2ccbc9e5251c3f0531ad6075c7e530b6",
    "_tokenId": 1,
    "creationBlock": 21592868,
    "_quantity": 20,
    "image": "http://image.com",
    "description": "My description",
    "tokenName": "Best token name",
    "burn": false,
    "symbol": "NFT-Symbol",
    "properties": {
      "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"
          }
        ]
      }
    },
    "favorites": 20,
    "wishes": 20,
    "isBlacklisted": false,
    "extraFiles": [
      "https://extra-file.com/file1"
    ],
    "minifiedImage": "https://extra-file.com/file1",
    "standard": "erc1155",
    "protocol": "text",
    "network": "bnb-chain",
    "isAsset": true,
    "createdAt": "2022-05-25T16:17:01.797Z",
    "updatedAt": "2022-05-25T16:17:01.797Z"
  }
}

Owners

The Owners API allows you to retrieve a list of owners associated with a specific NFT token by address and ID.

---

Returns a list of owners

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

Path parameters

address*string

Example: "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377"

_tokenId*number

Example: 1

Query parameters

Response

200400404

Body

application/json

results*array of NftOwner (object)

count*number

Request

JavaScriptCurlPython

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

Response

200400404

{
  "results": [
    {
      "address": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
      "chainId": 0,
      "owner": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
      "_tokenId": 20,
      "_quantity": 20,
      "userId": "text",
      "socialMedia": [],
      "createdAt": "2022-05-25T16:17:01.797Z",
      "updatedAt": "2022-05-25T16:17:01.797Z"
    }
  ],
  "count": 0
}

Minting Status

The Minting Status API enables you to check the minting status of a specific NFT token by address and ID.

---

Returns a token minting status

GET..//v1/minting-status/{address}/id/{_tokenId}

Path parameters

address*string

Example: "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377"

_tokenId*number

Example: 1

Response

200400404

Body

application/json

enum

[object Object]

Request

JavaScriptCurlPython

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

Response

200400404

{
  "PENDING": "pending",
  "OK": "ok",
  "ERROR": "error"
}

NFT Tags

The Tags API allows you to create tags for categorizing and organizing NFTs within your application. You can create tags and retrieve a list of requested tags.

---

Returns a list of requested tags

GET..//v1/tags

Query parameters

Response

200400404

Body

application/json

results*array of Tag (object)

count*number

Request

JavaScriptCurlPython

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

Response

200400404

{
  "results": [
    {
      "name": "Witcher",
      "tagId": 55,
      "usage": 2,
      "createdAt": "2022-08-12T14:21:28.449Z",
      "updatedAt": "2022-08-12T14:21:28.449Z"
    }
  ],
  "count": 0
}

Create Tag

POST..//v1/tags

Authorization

Authorization

Header parameters

Body

application/json

tagName*string

Response

201400401403404

Body

application/json

name*string

Example: "Witcher"

tagId*number

Example: 55

usage*number

Example: 2

createdAt*string (date-time)

Example: "2022-08-12T14:21:28.449Z"

updatedAt*string (date-time)

Example: "2022-08-12T14:21:28.449Z"

Request

JavaScriptCurlPython

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

Response

201400401403404

{
  "name": "Witcher",
  "tagId": 55,
  "usage": 2,
  "createdAt": "2022-08-12T14:21:28.449Z",
  "updatedAt": "2022-08-12T14:21:28.449Z"
}

NFT Categories

The Categories API provides endpoints for retrieving a list of requested categories for classifying NFTs.

---

Returns a list of requested categories

GET..//v1/categories

Query parameters

Response

200400404

Body

application/json

results*array of Category (object)

count*number

Request

JavaScriptCurlPython

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

Response

200400404

{
  "results": [
    {
      "name": "Real estate",
      "categoryId": 55,
      "parentId": 55,
      "usage": 1,
      "createdAt": "2022-05-25T16:17:01.797Z",
      "updatedAt": "2022-05-25T16:17:01.797Z"
    }
  ],
  "count": 0
}

NFT Search

The Search API allows you to search for NFTs based on specific search criteria. You can retrieve a list of requested NFTs matching the search text, facilitating efficient discovery of relevant NFTs.

---

Returns a list of requested Nft

GET..//v1/nft-search/{searchText}

Path parameters

searchText*string

Query parameters

Response

200400404

Body

application/json

results*array of Nft (object)

count*number

Request

JavaScriptCurlPython

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

Response

200400404

{
  "results": [
    {
      "address": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
      "createdBy": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
      "contractAddress": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
      "standard": "erc1155",
      "protocol": "text",
      "network": "bnb-chain",
      "chainId": 56,
      "creationBlock": 18504697,
      "version": 2,
      "isListed": true,
      "isAsset": true,
      "createdAt": "2022-05-25T16:17:01.797Z",
      "token": {
        "address": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
        "owner": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
        "createdBy": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
        "initialOwner": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
        "_bucketHash": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
        "transactionHash": "0xad2d281e499c6349ac590eb77695852b2ccbc9e5251c3f0531ad6075c7e530b6",
        "_tokenId": 1,
        "creationBlock": 21592868,
        "_quantity": 20,
        "image": "http://image.com",
        "description": "My description",
        "tokenName": "Best token name",
        "burn": false,
        "symbol": "NFT-Symbol",
        "properties": {
          "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"
              }
            ]
          }
        },
        "favorites": 20,
        "wishes": 20,
        "isBlacklisted": false,
        "extraFiles": [
          "https://extra-file.com/file1"
        ],
        "minifiedImage": "https://extra-file.com/file1",
        "standard": "erc1155",
        "protocol": "text",
        "network": "bnb-chain",
        "isAsset": true,
        "createdAt": "2022-05-25T16:17:01.797Z",
        "updatedAt": "2022-05-25T16:17:01.797Z"
      }
    }
  ],
  "count": 0
}