Get fungible token metadata

Path Parameters

principalFungible Token Contract Principal

Principal for the contract which owns the SIP-010 token

Pattern"^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}$"

Query Parameters

locale?Localization

Metadata localization to retrieve

Response Body

Default Response

TypeScript Definitions

Use the response body type in TypeScript.

name?string

Token name

symbol?string

Token symbol

decimals?integer

Number of decimal places clients should use to format this token's amounts

total_supply?string

Current circulating supply as reported by its contract. Clients should format this amount with the correct number of decimals before displaying to users

token_uri?string

URI for this token's metadata JSON

Format"uri"

description?string

Description

image_uri?string

Cached image URL

Format"uri"

image_thumbnail_uri?string

Cached image URL

Format"uri"

image_canonical_uri?string

Original image URL

Format"uri"

tx_idstring

ID for the transaction that deployed this token

sender_addressstring

Deployer address

asset_identifierstring

Clarity asset identifier

metadata?Metadata

Default Response

TypeScript Definitions

Use the response body type in TypeScript.

errorstring

Value in"Contract not found"

Default Response

TypeScript Definitions

Use the response body type in TypeScript.

errorstring

Value in"Token error"

messagestring

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

fetch("https://api.hiro.so//metadata/v1/ft/SP32XCD69XPS3GKDEXAQ29PJRDSD5AR643GNEEBXZ.fari-token?locale=string")

package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {
  url := "https://api.hiro.so//metadata/v1/ft/SP32XCD69XPS3GKDEXAQ29PJRDSD5AR643GNEEBXZ.fari-token?locale=string"

  req, _ := http.NewRequest("GET", url, nil)
  
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}

import requests

url = "https://api.hiro.so//metadata/v1/ft/SP32XCD69XPS3GKDEXAQ29PJRDSD5AR643GNEEBXZ.fari-token?locale=string"

response = requests.request("GET", url)

print(response.text)

{
  "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"
      ]
    }
  }
}

{
  "error": "Token not found"
}

{
  "error": "Token metadata fetch in progress"
}