TokensGet fungible token metadata

Get fungible token metadata

Retrieves metadata for a SIP-010 fungible token.

GET

/metadata/v1/ft/{principal}

Retrieves metadata for a SIP-010 fungible token.

Query parameters

localestring

Metadata localization to retrieve

Path parameters

principal
Required
string

Principal for the contract which owns the SIP-010 token

Example: "SP32XCD69XPS3GKDEXAQ29PJRDSD5AR643GNEEBXZ.fari-token"Pattern: "^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$"
Status codeDescription
200Default response
404Default response
422Default response
Terminal
curl -X GET "https://api.hiro.so/metadata/v1/ft/SP32XCD69XPS3GKDEXAQ29PJRDSD5AR643GNEEBXZ.fari-token"
Example response
{
  "name": "Wrapped USD",
  "symbol": "xUSD",
  "decimals": 8,
  "total_supply": "9999980000000",
  "token_uri": "ipfs://ipfs/Qmf9yDYuPTrp8NRUFf8xxDd5Ud24Dx9uYMwMn8o8G2cWPW/12200.json",
  "description": "Heavy hitters, all-stars and legends of the game join forces to create a collection of unique varsity jackets",
  "image_uri": "https://ipfs.io/ipfs/QmZMqhh2ztwuZ3Y8PyEp2z5auyH3TCm3nnr5ZfjjgDjd5q/12199.png",
  "image_thumbnail_uri": "https://ipfs.io/ipfs/QmZMqhh2ztwuZ3Y8PyEp2z5auyH3TCm3nnr5ZfjjgDjd5q/12199.png",
  "image_canonical_uri": "ipfs://ipfs/QmZMqhh2ztwuZ3Y8PyEp2z5auyH3TCm3nnr5ZfjjgDjd5q/12199.png",
  "tx_id": "0xef2ac1126e16f46843228b1dk4830e19eb7599129e4jf392cab9e65ae83a45c0",
  "sender_address": "ST399W7Z9WS0GMSNQGJGME5JAENKN56D65VGMGKGA",
  "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 fungible tokens

Get non-fungible token metadata