Get BRC-20 balances

Path Parameters

addressAddress

Bitcoin address

Query Parameters

ticker?array<string>

block_height?Block Height

Bitcoin block height

Pattern"^[0-9]+$"

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>

curl -X GET "https://api.hiro.so//ordinals/v1/brc-20/balances/bc1p8aq8s3z9xl87e74twfk93mljxq6alv4a79yheadx33t9np4g2wkqqt8kc5?ticker=string&block_height=777678&offset=0&limit=1"

fetch("https://api.hiro.so//ordinals/v1/brc-20/balances/bc1p8aq8s3z9xl87e74twfk93mljxq6alv4a79yheadx33t9np4g2wkqqt8kc5?ticker=string&block_height=777678&offset=0&limit=1")

package main

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

func main() {
  url := "https://api.hiro.so//ordinals/v1/brc-20/balances/bc1p8aq8s3z9xl87e74twfk93mljxq6alv4a79yheadx33t9np4g2wkqqt8kc5?ticker=string&block_height=777678&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/balances/bc1p8aq8s3z9xl87e74twfk93mljxq6alv4a79yheadx33t9np4g2wkqqt8kc5?ticker=string&block_height=777678&offset=0&limit=1"

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

print(response.text)

{
  "limit": 20,
  "offset": 0,
  "total": 1,
  "results": [
    {
      "ticker": "PEPE",
      "available_balance": "1500.00000",
      "transferrable_balance": "500.00000",
      "overall_balance": "2000.00000"
    }
  ]
}