Get BRC-20 token holders

Retrieves a list of holders and their balances for a particular BRC-20 token.

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

Path Parameters

tickerstring

Query Parameters

offset?Offset

Result offset

limit?Limit

Results per page

Range1 <= value <= 60

Response Body

Default Response

TypeScript Definitions

Use the response body type in TypeScript.

limitinteger
offsetinteger
totalinteger
resultsarray<object>

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/holders?offset=0&limit=1"
fetch("https://api.hiro.so//ordinals/v1/brc-20/tokens/string/holders?offset=0&limit=1")
package main

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

func main() {
  url := "https://api.hiro.so//ordinals/v1/brc-20/tokens/string/holders?offset=0&limit=1"

  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/holders?offset=0&limit=1"

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

print(response.text)
{
  "limit": 20,
  "offset": 0,
  "total": 1,
  "results": [
    {
      "address": "bc1pvwh2dl6h388x65rqq47qjzdmsqgkatpt4hye6daf7yxvl0z3xjgq247aq8",
      "overall_balance": "2000.00000"
    }
  ]
}
{
  "error": "Not found"
}