getMetadata

Pulls all relevant metadata in JSON format for a given NFT. Compatible with ERC-721 and ERC-1155 contract types. Also provides block number for context.

Request

Endpoint

GET https://api.metcy.io/v1/eth/getMetadata/

Headers

Key
Value

Authorization

Token { YOUR-API-KEY }

Parameters

Parameter
Description

contractAddress

Hexadecimal address that defines the NFT collection.

tokenId

Unique identifier that specifies the NFT within the contract address.

Example

curl --location --request GET 'https://api.metcy.io/v1/eth/getMetadata/?contractAddress=0xF43Aaa80a8F9dE69bc71aeA989AfCeB8DB7b690F&tokenId=5377'
--header 'Authorization: Token 81fc29d081f2f2836e187837a221be**********'

Response

Request Status Code

Response
Interpretation

200

Success! Metadata is provided in JSON format.

401

User authentication details failed.

Body

{
    "contracttype": "ERC1155",
    "block": 16151258,
    "symbol": "SDC",
    "name": "Soccer Doge Club",
    "data": {
        "name": "Soccer Doge #5377",
        "description": "Each Soccer Doge is algorithmically generated by combining more than 100 attributes of different rarities in 10 categories (fur, background, eyes, mouth, nose, shirt, hat, earrings, necklace and beard).",
        "image": "https://soccerdogeclubnft.s3.us-west-1.amazonaws.com/imgs/sdc-img-5377.png",
        "attributes": [
            {
                "trait_type": "BACKGROUND",
                "value": "Purple"
            },
            {
                "trait_type": "FUR",
                "value": "Normal"
            },
            {
                "trait_type": "EARRING",
                "value": "Silver Point"
            },
            {
                "trait_type": "EYES",
                "value": "Yellow"
            },
            {
                "trait_type": "BEARD",
                "value": "Scruffy"
            },
            {
                "trait_type": "MOUTH",
                "value": "Volado Cig"
            },
            {
                "trait_type": "NOSE",
                "value": "OliveGreen"
            }
        ],
        "properties": {
            "BACKGROUND": "Purple",
            "FUR": "Normal",
            "EARRING": "Silver Point",
            "EYES": "Yellow",
            "BEARD": "Scruffy",
            "MOUTH": "Volado Cig",
            "NOSE": "OliveGreen"
        }
    }
}

Interpretation

Note that some NFTs do not provide additional data within a URI path. In these cases, extended details may not be available.

This endpoint serves validation for both ERC721 and ERC1155 ABI contract types. For more information on what distinguishes these types, please refer to Ethereum's documentation.

Last updated