TokensGet fungible token metadata

Get fungible token metadata

Retrieves metadata for a SIP-010 fungible token.

GET
/metadata/v1/ft/{principal}

Fungible Token Metadata

Retrieves metadata for a SIP-010 Fungible Token

Query Parameters

localeLocalization

Metadata localization to retrieve

Path Parameters

principal
Required
Fungible Token Contract Principal

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
/metadata/v1/ft/{principal}

Terminal
$ 
curl -X GET "https://api.hiro.so/metadata/v1/ft/SP32XCD69XPS3GKDEXAQ29PJRDSD5AR643GNEEBXZ.fari-token?locale=string"

{

  "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": "0x5642ca7d68976b6b2a2055689d9a57de26d67f0dd8b016d1b0d94cb634454cdd",

  "sender_address": "SPZA22A4D15RKH5G8XDGQ7BPC20Q5JNMH0VQKSR6",

  "asset_identifier": "SPZA22A4D15RKH5G8XDGQ7BPC20Q5JNMH0VQKSR6.token-ststx-earn-v1::stSTXearn",

  "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