These docs are for v2.0. Click to read the latest docs for v3.0.

Retrieve NFT Metadata

How to retrieve the metadata of an NFT by tokenId.

This API endpoint retrieves the metadata of a Non-Fungible Token (NFT) by its unique token ID. The token ID serves as a unique identifier for each NFT within a collection, allowing users to access detailed information about a specific NFT.

Request Endpoint: reference

GET /api/v2/contracts/{secretType}/{contractAddress}/tokens/{tokenId}/metadata
ParameterParam TypeDescriptionData TypeMandatory
{secretType}PathThe blockchain of the contract.String
{contractAddress}PathThe contract address.String
{tokenId}PathThe id of the token whose metadata you want to fetch.Integer

Example Request:

GET /api/v2/contracts/MATIC/0x8b92df864bc1cdd103d92cba3c18b3f7492d815a/tokens/2/metadata

Response Body:

{
    "success": true,
    "result": {
        "name": "NFT with metadata on IPFS",
        "description": "This NFTs metadata is stored on IPFS",
        "image": "https://static.wikia.nocookie.net/parody/images/4/42/74915084_10162764640400387_6139958579186106368_o.jpg",
        "imagePreview": "https://static.wikia.nocookie.net/parody/images/4/42/74915084_10162764640400387_6139958579186106368_o.jpg",
        "imageThumbnail": "https://static.wikia.nocookie.net/parody/images/4/42/74915084_10162764640400387_6139958579186106368_o.jpg",
        "backgroundColor": "#eeeeee",
        "background_color": "#eeeeee",
        "animationUrl": "https://img.arkane.network/marketing/SpaceChickens/space_chickens_trailer.mp4",
        "animation_url": "https://img.arkane.network/marketing/SpaceChickens/space_chickens_trailer.mp4",
        "externalUrl": "https://en.wikipedia.org/wiki/Space_Chickens_in_Space",
        "external_url": "https://en.wikipedia.org/wiki/Space_Chickens_in_Space",
        "animationUrls": [
            {
                "type": "video",
                "value": "https://img.arkane.network/marketing/SpaceChickens/space_chickens_trailer.mp4"
            },
            {
                "type": "audio",
                "value": "https://file-examples-com.github.io/uploads/2017/11/file_example_WAV_10MG.wav"
            }
        ],
        "attributes": [
            {
                "type": "property",
                "name": "Talent",
                "value": "Leadership",
                "traitType": "Talent",
                "trait_type": "Talent"
            },
            {
                "type": "property",
                "name": "Allergic",
                "value": "Monstonuts",
                "traitType": "Allergic",
                "trait_type": "Allergic"
            },
            {
                "type": "property",
                "name": "Hobby",
                "value": "Scouts",
                "traitType": "Hobby",
                "trait_type": "Hobby"
            },
            {
                "type": "stat",
                "name": "Cool",
                "value": "9",
                "maxValue": "10",
                "displayType": "number",
                "display_type": "number",
                "traitType": "Cool",
                "trait_type": "Cool"
            },
            {
                "type": "stat",
                "name": "Daring",
                "value": "8",
                "maxValue": "10",
                "displayType": "number",
                "display_type": "number",
                "traitType": "Daring",
                "trait_type": "Daring"
            },
            {
                "type": "stat",
                "name": "Noise",
                "value": "8",
                "maxValue": "10",
                "displayType": "number",
                "display_type": "number",
                "traitType": "Noise",
                "trait_type": "Noise"
            },
            {
                "type": "stat",
                "name": "Age",
                "value": "3",
                "displayType": "number",
                "display_type": "number",
                "traitType": "Age",
                "trait_type": "Age"
            },
            {
                "type": "boost",
                "name": "Crafting",
                "value": "+5",
                "displayType": "boost_number",
                "display_type": "boost_number",
                "traitType": "Crafting",
                "trait_type": "Crafting"
            },
            {
                "type": "boost",
                "name": "Leadership",
                "value": "+10",
                "displayType": "boost_number",
                "display_type": "boost_number",
                "traitType": "Leadership",
                "trait_type": "Leadership"
            },
            {
                "type": "system",
                "name": "tokenTypeId",
                "value": "1",
                "traitType": "Token Type ID",
                "trait_type": "Token Type ID"
            },
            {
                "type": "property",
                "name": "maxSupply",
                "value": "25",
                "traitType": "Max Supply",
                "trait_type": "Max Supply"
            },
            {
                "type": "property",
                "name": "mintNumber",
                "value": "1",
                "traitType": "Mint Number",
                "trait_type": "Mint Number"
            }
        ],
        "contract": {
            "address": "0x8b92df864bc1cdd103d92cba3c18b3f7492d815a",
            "name": "NFT Collection",
            "symbol": "NFTC",
            "image": "https://techround.co.uk/wp-content/uploads/2022/01/Venly-logo.png",
            "imageUrl": "https://techround.co.uk/wp-content/uploads/2022/01/Venly-logo.png",
            "image_url": "https://techround.co.uk/wp-content/uploads/2022/01/Venly-logo.png",
            "description": "Sample description",
            "externalLink": "www.venly.io",
            "external_link": "www.venly.io",
            "externalUrl": "www.venly.io",
            "external_url": "www.venly.io",
            "media": [],
            "type": "ERC_1155"
        },
        "fungible": false
    }
}