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

addressstring · min: 42 · max: 42required

Example: 0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377

idnumberrequired

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

404

200

{
  "address": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
  "createdBy": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
  "contractAddress": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
  "protocol": "text",
  "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",
    "favorites": 20,
    "wishes": 20,
    "isBlacklisted": true,
    "minifiedImage": "https://extra-file.com/file1",
    "protocol": "text",
    "chainId": 1,
    "isAsset": true,
    "qrDescription": "Description for QR code",
    "createdAt": "2022-05-25T16:17:01.797Z",
    "updatedAt": "2022-05-25T16:17:01.797Z",
    "standard": "erc1155",
    "network": "bnb-chain",
    "extraFiles": [
      "https://extra-file.com/file1"
    ],
    "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"
          }
        ]
      }
    }
  },
  "name": "Metaprotocol Factory",
  "standard": "erc1155",
  "network": "bnb-chain"
}

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

Authorizations

Query parameters

skipnumber

Example: 2

limitnumber · min: 1

Example: 2

addressstring · min: 42 · max: 42

Example: 0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377

standardstring · enum

Options: erc1155, erc721

protocolstring · min: 1 · max: 20

networkstring · enum

Options: bnb-chain, ethereum, polygon, base

_tokenIdnumber

Example: 1

creationBlocknumber · min: 1

Example: 21592868

categoryIdnumber · min: 1

Example: 55

tagIdnumber · min: 1

Example: 55

categoryIdsnumber[] · min: 1

tokenIdsnumber[]

tagIdsnumber[] · min: 1

networksstring · enum[]

asset_categorystring · min: 1 · max: 20

asset_subcategoriesstring · min: 1 · max: 20

asset_tagsstring · min: 1 · max: 20

tokensstring

Stringified array of tokens with chain ID (optional), contract address, and token ID

Example: [{"chainId":11155111,"contractAddress":"0x91945DCD15b44eB33dE4D00897843C1Ee524fA88","tokenId":3},{"chainId":80002,"contractAddress":"0x91945DCD15b44eB33dE4D00897843C1Ee524fA88","tokenId":1234}]

skipTokensobject

Tokens to skip

Example: {"skipTokens":{"0x91945DCD15b44eB33dE4D00897843C1Ee524fA88":[1313]}}

showBlacklistedboolean

collectionsobject

Token collections

Example: {"collections":{"0x91945DCD15b44eB33dE4D00897843C1Ee524fA88":"collection1"}}

contractAddressesstring[]

protocolsstring[]

excludeCollectionsboolean

sortobject

Example: {"token._tokenId":"desc","token.creationBlock":"desc","token.favorites":"desc","token.wishes":"desc"}

Header parameters

Authorizationstringrequired

asduf823hf-sa98ehf938rh

x-account-walletstringrequired

0xd1afbab5cacb45491ce002a6026c1401340eae6a

x-account-useridstringrequired

5a945f88-1de8cb-c6a1b4-1314ebac6bd1

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

401

403

404

200

{
  "count": 1,
  "results": [
    {
      "address": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
      "createdBy": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
      "contractAddress": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
      "protocol": "text",
      "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",
        "favorites": 20,
        "wishes": 20,
        "isBlacklisted": true,
        "minifiedImage": "https://extra-file.com/file1",
        "protocol": "text",
        "chainId": 1,
        "isAsset": true,
        "qrDescription": "Description for QR code",
        "createdAt": "2022-05-25T16:17:01.797Z",
        "updatedAt": "2022-05-25T16:17:01.797Z",
        "standard": "erc1155",
        "network": "bnb-chain",
        "extraFiles": [
          "https://extra-file.com/file1"
        ],
        "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"
              }
            ]
          }
        }
      },
      "name": "Metaprotocol Factory",
      "standard": "erc1155",
      "network": "bnb-chain"
    }
  ]
}

Returns a Nft

get

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

Authorizations

Path parameters

addressstring · min: 42 · max: 42required

Example: 0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377

idnumberrequired

chainIdnumberrequired

Header parameters

Authorizationstringrequired

asduf823hf-sa98ehf938rh

x-account-walletstringrequired

0xd1afbab5cacb45491ce002a6026c1401340eae6a

x-account-useridstringrequired

5a945f88-1de8cb-c6a1b4-1314ebac6bd1

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '..//v1/internal/tokens/{address}/id/{id}/rich' \
  --header 'Authorization: text' \
  --header 'x-account-wallet: text' \
  --header 'x-account-userid: text'

200

400

401

403

404

200

{
  "address": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
  "createdBy": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
  "contractAddress": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
  "protocol": "text",
  "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",
    "favorites": 20,
    "wishes": 20,
    "isBlacklisted": true,
    "minifiedImage": "https://extra-file.com/file1",
    "protocol": "text",
    "chainId": 1,
    "isAsset": true,
    "qrDescription": "Description for QR code",
    "createdAt": "2022-05-25T16:17:01.797Z",
    "updatedAt": "2022-05-25T16:17:01.797Z",
    "standard": "erc1155",
    "network": "bnb-chain",
    "extraFiles": [
      "https://extra-file.com/file1"
    ],
    "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"
          }
        ]
      }
    }
  },
  "name": "Metaprotocol Factory",
  "standard": "erc1155",
  "network": "bnb-chain"
}

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

addressstring · min: 42 · max: 42required

Example: 0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377

_tokenIdnumberrequired

Example: 1

Query parameters

_tokenIdstring · enum

Sort by..

Example: desc

Options: desc, asc

createdAtstring · enum

Sort by..

Example: desc

Options: desc, asc

_quantitystring · enum

Sort by..

Example: desc

Options: desc, asc

skipnumber

Example: 2

limitnumber · min: 1

Example: 2

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

404

200

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

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

addressstring · min: 42 · max: 42required

Example: 0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377

_tokenIdnumberrequired

Example: 1

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

404

200

{
  "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

skipnumber

Example: 2

limitnumber · min: 1

Example: 2

usagenumber · min: 1

Example: 1

tagIdsnumber[] · min: 1

parentIdsnumber[] · min: 1

tagNamestring · max: 20

sortobject

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

404

200

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

Create Tag

post

/v1/tags

Authorizations

Header parameters

Authorizationstringrequired

asduf823hf-sa98ehf938rh

x-account-walletstringrequired

0xd1afbab5cacb45491ce002a6026c1401340eae6a

x-account-useridstringrequired

5a945f88-1de8cb-c6a1b4-1314ebac6bd1

Body

tagNamestring · max: 20required

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '..//v1/tags' \
  --header 'Authorization: text' \
  --header 'x-account-wallet: text' \
  --header 'x-account-userid: text' \
  --header 'Content-Type: application/json' \
  --data '{"tagName":"text"}'

201

400

401

403

404

201

{
  "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

skipnumber

Example: 2

limitnumber · min: 1

Example: 2

usagenumber · min: 1

Example: 1

categoryIdsnumber[] · min: 1

parentIdsnumber[] · min: 1

categoryNamestring · min: 2 · max: 20

Pattern: /^([-\w]+ )+[-\w]+$|^[-\w]+$/

sortobject

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

404

200

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

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

searchTextstringrequired

Query parameters

skipnumber

Example: 2

limitnumber · min: 1

Example: 2

addressstring · min: 42 · max: 42

Example: 0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

404

200

{
  "count": 1,
  "results": [
    {
      "address": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
      "createdBy": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
      "contractAddress": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
      "protocol": "text",
      "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",
        "favorites": 20,
        "wishes": 20,
        "isBlacklisted": true,
        "minifiedImage": "https://extra-file.com/file1",
        "protocol": "text",
        "chainId": 1,
        "isAsset": true,
        "qrDescription": "Description for QR code",
        "createdAt": "2022-05-25T16:17:01.797Z",
        "updatedAt": "2022-05-25T16:17:01.797Z",
        "standard": "erc1155",
        "network": "bnb-chain",
        "extraFiles": [
          "https://extra-file.com/file1"
        ],
        "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"
              }
            ]
          }
        }
      },
      "name": "Metaprotocol Factory",
      "standard": "erc1155",
      "network": "bnb-chain"
    }
  ]
}