Get fungible tokens

Retrieves information about fungible tokens.

GET
/metadata/v1/ft

Query Parameters

name?string
symbol?string
address?Stacks Address

Stacks Address

Pattern"^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}"
valid_metadata_only?boolean

If enabled, only tokens with valid SIP-016 metadata will be returned

offset?Offset

Result offset

limit?Limit

Results per page

Range1 <= value <= 60
order_by?Order By

Parameter to order results by

order?Order

Results order

Response Body

Default Response

TypeScript Definitions

Use the response body type in TypeScript.

limitinteger
offsetinteger
totalinteger
resultsarray<Ft Basic Metadata Response>
curl -X GET "https://api.hiro.so//metadata/v1/ft?name=string&symbol=string&address=SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9&valid_metadata_only=true&offset=0&limit=1&order_by=name&order=asc"
fetch("https://api.hiro.so//metadata/v1/ft?name=string&symbol=string&address=SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9&valid_metadata_only=true&offset=0&limit=1&order_by=name&order=asc")
package main

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

func main() {
  url := "https://api.hiro.so//metadata/v1/ft?name=string&symbol=string&address=SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9&valid_metadata_only=true&offset=0&limit=1&order_by=name&order=asc"

  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?name=string&symbol=string&address=SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9&valid_metadata_only=true&offset=0&limit=1&order_by=name&order=asc"

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

print(response.text)
{
  "limit": 20,
  "offset": 0,
  "total": 1,
  "results": [
    {
      "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",
      "asset_identifier": "SPZA22A4D15RKH5G8XDGQ7BPC20Q5JNMH0VQKSR6.token-ststx-earn-v1::stSTXearn",
      "contract_principal": "SP1H1733V5MZ3SZ9XRW9FKYGEZT0JDGEB8Y634C7R.miamicoin-token-v2"
    }
  ]
}