Get BRC-20 token details

Retrieves information for a BRC-20 token, including supply and holders.

GET
/ordinals/v1/brc-20/tokens/{ticker}

Path Parameters

tickerstring

Response Body

Default Response

TypeScript Definitions

Use the response body type in TypeScript.

tokenBRC-20 Token Response
supplyobject

Default Response

TypeScript Definitions

Use the response body type in TypeScript.

errorstring
Value in"Not found"
curl -X GET "https://api.hiro.so//ordinals/v1/brc-20/tokens/string"
fetch("https://api.hiro.so//ordinals/v1/brc-20/tokens/string")
package main

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

func main() {
  url := "https://api.hiro.so//ordinals/v1/brc-20/tokens/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//ordinals/v1/brc-20/tokens/string"

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

print(response.text)
{
  "token": {
    "id": "1463d48e9248159084929294f64bda04487503d30ce7ab58365df1dc6fd58218i0",
    "number": 248751,
    "block_height": 752860,
    "tx_id": "1463d48e9248159084929294f64bda04487503d30ce7ab58365df1dc6fd58218",
    "address": "bc1pvwh2dl6h388x65rqq47qjzdmsqgkatpt4hye6daf7yxvl0z3xjgq247aq8",
    "ticker": "PEPE",
    "max_supply": "21000000",
    "mint_limit": "100000",
    "decimals": 18,
    "deploy_timestamp": 1677733170000,
    "minted_supply": "1000000",
    "tx_count": 300000
  },
  "supply": {
    "max_supply": "21000000",
    "minted_supply": "1000000",
    "holders": 240
  }
}
{
  "error": "Not found"
}