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

Retrieve NFT metadata

How to retrieve the metadata of an NFT token type (template) from one of your contracts.

Request Endpoint: reference

GET /api/contracts/{contractId}/token-types/{typeId}/metadata
ParameterParam TypeDescriptionData TypeMandatory
{contractId}PathThis is the id of the contract.Integer
{typeId}PathThis is the id of the token-type.Integer

Example Request:

GET https://nft-api.venly.io/api/minter/contracts/203/token-types/1/metadata

Response Body:

{
    "name": "Chuck The Rooster",
    "description": "Chuck is a Male Tall Chicken Who is the Leader of The Chicken Siblings. He is Cool, Daring and Wacky. He can be Selfish and Stubborn When it Comes To Challenges, But he is An True Softie when it Comes To His Siblings. In Rebel to the Beak, It revealed that He is Allergic to Monstonuts and In The Good, The Bad and The Clucky, It also Revealed that He Used to Be one Of the Scouts from Slurp,s Little Cowboys Scout Camp along With Finley, Ainta and Hugo. He is the youngest of the three.",
    "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",
    "externalUrl": "https://en.wikipedia.org/wiki/Space_Chickens_in_Space",
    "external_url": "https://en.wikipedia.org/wiki/Space_Chickens_in_Space",
    "animationUrls": [],
    "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"
        }
    ],
    "contract": {
        "address": "0xd3343d667d8d2c1c9dc6fe36d2b3f6b569e4d08b",
        "name": "Space Chickens",
        "symbol": "SPACECHICKS",
        "image": "https://static.wikia.nocookie.net/logopedia/images/a/aa/Space_Chickens_in_Space.jpg",
        "imageUrl": "https://static.wikia.nocookie.net/logopedia/images/a/aa/Space_Chickens_in_Space.jpg",
        "image_url": "https://static.wikia.nocookie.net/logopedia/images/a/aa/Space_Chickens_in_Space.jpg",
        "description": "Space Chickens in Space is an American-Australian-Mexican-British-Irish animated television series produced by Ánima Estudios in Mexico, Studio Moshi in Australia. A trio of chickens—Chuck, Starley and Finley—are taken from their home and mistakenly enrolled in an elite intergalactic former military academy. It would take all their strength, and teamwork, to survive every escapade they have.",
        "externalLink": "https://en.wikipedia.org/wiki/Space_Chickens_in_Space",
        "external_link": "https://en.wikipedia.org/wiki/Space_Chickens_in_Space",
        "externalUrl": "https://en.wikipedia.org/wiki/Space_Chickens_in_Space",
        "external_url": "https://en.wikipedia.org/wiki/Space_Chickens_in_Space",
        "media": [
            {
                "type": "image",
                "value": "https://dg31sz3gwrwan.cloudfront.net/fanart/355763/1357791-0-q80.jpg"
            }
        ],
        "type": "ERC_1155"
    },
    "asset_contract": {
        "address": "0xd3343d667d8d2c1c9dc6fe36d2b3f6b569e4d08b",
        "name": "Space Chickens",
        "symbol": "SPACECHICKS",
        "image": "https://static.wikia.nocookie.net/logopedia/images/a/aa/Space_Chickens_in_Space.jpg",
        "imageUrl": "https://static.wikia.nocookie.net/logopedia/images/a/aa/Space_Chickens_in_Space.jpg",
        "image_url": "https://static.wikia.nocookie.net/logopedia/images/a/aa/Space_Chickens_in_Space.jpg",
        "description": "Space Chickens in Space is an American-Australian-Mexican-British-Irish animated television series produced by Ánima Estudios in Mexico, Studio Moshi in Australia. A trio of chickens—Chuck, Starley and Finley—are taken from their home and mistakenly enrolled in an elite intergalactic former military academy. It would take all their strength, and teamwork, to survive every escapade they have.",
        "externalLink": "https://en.wikipedia.org/wiki/Space_Chickens_in_Space",
        "external_link": "https://en.wikipedia.org/wiki/Space_Chickens_in_Space",
        "externalUrl": "https://en.wikipedia.org/wiki/Space_Chickens_in_Space",
        "external_url": "https://en.wikipedia.org/wiki/Space_Chickens_in_Space",
        "media": [
            {
                "type": "image",
                "value": "https://dg31sz3gwrwan.cloudfront.net/fanart/355763/1357791-0-q80.jpg"
            }
        ],
        "type": "ERC_1155"
    },
    "fungible": false
}