getNFTMetadata | Alchemy Docs

1 curl -G https://eth-mainnet.g.alchemy.com/nft/v2/docs-demo/getNFTMetadata \ 2 -d contractAddress=0xe785E82358879F061BC3dcAC6f0444462D4b5330 \ 3 -d tokenId=44

1 { 2 "contract": { 3 "address": "foo" 4 }, 5 "id": { 6 "tokenId": "44", 7 "tokenMetadata": { 8 "tokenType": "ERC721" 9 } 10 }, 11 "balance": "foo", 12 "title": "foo", 13 "description": "foo", 14 "tokenUri": { 15 "raw": "foo", 16 "gateway": "foo" 17 }, 18 "media": { 19 "raw": "foo", 20 "gateway": "foo", 21 "thumbnail": "foo", 22 "format": "foo", 23 "bytes": 42 24 }, 25 "metadata": { 26 "image": "foo", 27 "external_url": "foo", 28 "background_color": "foo", 29 "name": "foo", 30 "description": "foo", 31 "attributes": [ 32 { 33 "value": "foo", 34 "trait_type": "foo" 35 } 36 ], 37 "media": [ 38 { 39 "raw": "foo", 40 "gateway": "foo", 41 "thumbnail": "foo", 42 "format": "foo", 43 "bytes": 42 44 } 45 ] 46 }, 47 "timeLastUpdated": "foo", 48 "error": "foo", 49 "contractMetadata": { 50 "name": "foo", 51 "symbol": "foo", 52 "totalSupply": "foo", 53 "tokenType": "ERC721", 54 "contractDeployer": "foo", 55 "deployedBlockNumber": 42, 56 "opensea": { 57 "floorPrice": 42, 58 "collectionName": "foo", 59 "safelistRequestStatus": "foo", 60 "imageUrl": "foo", 61 "description": "foo", 62 "externalUrl": "foo", 63 "twitterUsername": "foo", 64 "discordUrl": "foo", 65 "lastIngestedAt": "foo" 66 } 67 }, 68 "spamInfo": { 69 "isSpam": "foo", 70 "spamClassifications": [ 71 "foo" 72 ] 73 }, 74 "acquiredAt": { 75 "blockTimestamp": "foo", 76 "blockNumber": "foo" 77 } 78 }

Gets the metadata associated with a given NFT.

Path parameters

apiKeystringRequired

Query parameters

contractAddressstringRequired

String - Contract address for the NFT contract (ERC721 and ERC1155 supported).

tokenIdstringRequired

String - The ID of the token. Can be in hex or decimal format.

tokenTypestringOptional

String - ‘ERC721’ or ‘ERC1155’; specifies type of token to query for. API requests will perform faster if this is specified.

tokenUriTimeoutInMsintegerOptional

No set timeout by default - When metadata is requested, this parameter is the timeout (in milliseconds) for the website hosting the metadata to respond. If you want to only access the cache and not live fetch any metadata for cache misses then set this value to 0.

refreshCachebooleanOptionalDefaults to false

Defaults to false for faster response times. If true will refresh metadata for given token. If false will check the cache and use it or refresh if cache doesn't exist.

Response

contractobject or null

Object - Contract for returned NFT

idobject or null

balancestring or null

String - Token balance

titlestring or null

String - Name of the NFT asset.

descriptionstring or null

String - Brief human-readable description

tokenUriobject or null

mediaobject or null

metadataobject or null

Relevant metadata for NFT contract. This is useful for viewing image url, traits, etc. without having to follow the metadata url in tokenUri to parse manually.

timeLastUpdatedstring or null

String - ISO timestamp of the last cache refresh for the information returned in the metadata field.

errorstring or null

String - A string describing a particular reason that we were unable to fetch complete metadata for the NFT.

contractMetadataobject or null

spamInfoobject or null

Information about whether and why a contract was marked as spam.

acquiredAtobject or null

Only present if the request specified orderBy=transferTime.