Retrieve Token-type Metadata

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

This endpoint retrieves the metadata of a specific token-type under an NFT contract. The blockchain, contract address, and the tokenTypeId needs to be supplied which is unique for each token-type. The response body includes complete information on the token-type metadata as well as the NFT contract.

Request Endpoint: reference

GET /api/v3/erc1155/contracts/{chain}/{contractAddress}/token-types/{tokenTypeId}/metadata

Parameter	Param Type	Description	Data Type	Mandatory
`{chain}`	Path	The blockchain of the contract.	String	✅
`{contractAddress}`	Path	The contract address.	String	✅
`{tokenTypeId}`	Path	The `id` of the token-type whose metadata you want to fetch.	Integer	✅

Example Request:

GET /api/v3/erc1155/contracts/MATIC/0x30d6cff9cb268c59c75a94755b2c60e118d65657/token-types/1/metadata

Response Body:

{
    "success": true,
    "result": {
        "name": "My first NFT",
        "description": "Venly",
        "image": "https://storage-qa.venly.io/applications/1f64ded9-2a05-4824-b682-661023359357/StickFigureHi.png",
        "imagePreview": "https://storage-qa.venly.io/applications/1f64ded9-2a05-4824-b682-661023359357/StickFigureHi.png",
        "imageThumbnail": "https://storage-qa.venly.io/applications/1f64ded9-2a05-4824-b682-661023359357/StickFigureHi.png",
        "animationUrls": [],
        "attributes": [
            {
                "type": "system",
                "name": "tokenTypeId",
                "value": "1",
                "traitType": "Token Type ID",
                "trait_type": "Token Type ID"
            }
        ],
        "contract": {
            "address": "0x30d6cff9cb268c59c75a94755b2c60e118d65657",
            "name": "My first collection",
            "symbol": "MYFICO",
            "image": "https://pbs.twimg.com/profile_images/1669300450649157635/4xg-wsbK_400x400.jpg",
            "imageUrl": "https://pbs.twimg.com/profile_images/1669300450649157635/4xg-wsbK_400x400.jpg",
            "image_url": "https://pbs.twimg.com/profile_images/1669300450649157635/4xg-wsbK_400x400.jpg",
            "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
    }
}

Updated 6 months ago

Did this page help you?