TokensGet semi-fungible token metadata

Get semi-fungible token metadata

Retrieves information about semi-fungible tokens.

GET

/metadata/v1/sft/{principal}/{token_id}

Retrieves metadata for a SIP-013 semi-fungible token.

Query parameters

localestring

Metadata localization to retrieve

Path parameters

principal
Required
string

SIP-013 compliant smart contract principal

Example: "SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.key-alex-autoalex-v1"Pattern: "^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$"

token_id
Required
integer

Token ID to retrieve

Example: "35"
Status codeDescription
200Default response
404Default response
422Default response
Terminal
curl -X GET "https://api.hiro.so/metadata/v1/sft/SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.key-alex-autoalex-v1/35"
Example response
{
  "token_uri": "ipfs://ipfs/Qmf9yDYuPTrp8NRUFf8xxDd5Ud24Dx9uYMwMn8o8G2cWPW/12200.json",
  "decimals": 6,
  "total_supply": "250",
  "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"
      ]
    }
  }
}

Get non-fungible token metadata