Hiro Docs

GET
/metadata/v1/ft

Retrieves a list of fungible tokens.

Query Parameters

`name`string

The name of the token

`symbol`string

The symbol of the token

`address`string

Stacks Address

Example: "SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9"Pattern: "^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}"

`offset`integer

Result offset

Minimum: 0

`limit`integer

Results per page

Minimum: 1Maximum: 60

`order_by`Any properties in string, string

Parameter to order results by

`order`Any properties in string, string

Results order

Status code	Description
`200`	Default response

Terminal

curl -X GET "https://api.hiro.so/metadata/v1/ft"

Example response

{
  "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",
      "contract_principal": "SP1H1733V5MZ3SZ9XRW9FKYGEZT0JDGEB8Y634C7R.miamicoin-token-v2"
    }
  ]
}

Get fungible tokens

GET/metadata/v1/ft

Query Parameters

namestring

symbolstring

addressstring

offsetinteger

limitinteger

order_byAny properties in string, string

orderAny properties in string, string

Schema