Get non-fungible token metadata
Retrieves metadata for a SIP-009 non-fungible token.
GET
/metadata/v1/nft/{principal}/{token_id}
Non-Fungible Token Metadata
Retrieves metadata for a SIP-009 Non-Fungible Token
Query Parameters
localeLocalization
Metadata localization to retrieve
Path Parameters
principalRequiredNon-Fungible Token Contract Principal
SIP-009 compliant smart contract principal
Example:"SP497E7RX3233ATBS2AB9G4WTHB63X5PBSP5VGAQ.boomboxes-cycle-12"Pattern: "^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$"token_idRequiredToken ID
Token ID to retrieve
Example:"35"| Status code | Description |
|---|---|
200 | Default Response |
404 | Default Response |
422 | Default Response |
Terminal
$curl -X GET "https://api.hiro.so/metadata/v1/nft/SP497E7RX3233ATBS2AB9G4WTHB63X5PBSP5VGAQ.boomboxes-cycle-12/35?locale=string"
{"token_uri": "ipfs://ipfs/Qmf9yDYuPTrp8NRUFf8xxDd5Ud24Dx9uYMwMn8o8G2cWPW/12200.json","metadata": {"sip": 16,"name": "Satoshi's Team #12200","description": "Heavy hitters, all-stars and legends of the game join forces to create a collection of unique varsity jackets","image": "ipfs://ipfs/QmZMqhh2ztwuZ3Y8PyEp2z5auyH3TCm3nnr5ZfjjgDjd5q/12199.png","cached_image": "https://ipfs.io/ipfs/QmZMqhh2ztwuZ3Y8PyEp2z5auyH3TCm3nnr5ZfjjgDjd5q/12199.png","cached_thumbnail_image": "https://ipfs.io/ipfs/QmZMqhh2ztwuZ3Y8PyEp2z5auyH3TCm3nnr5ZfjjgDjd5q/12199.png","attributes": [{"trait_type": "Background","display_type": "string","value": "value"}],"properties": {"collection": "Foo Collection","total_supply": "10000"},"localization": {"uri": "http://token.com/metadata?hl={locale}","default": "en","locales": ["en","jp"]}}}