Get Address BRC-20 Summary

Obtain BRC20 token summary by address, including available balance, transferable balance

get

/v1/indexer/address/{address}/brc20/summary

Authorizations

Path parameters

addressstringrequired

Address

Query parameters

startintegerrequired

Start offset

Example: 0

limitintegerrequired

Number of inscriptions returned

Example: 16

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://open-api.unisat.io/v1/indexer/address/{address}/brc20/summary?start=1&limit=1' \
  --header 'Authorization: Bearer JWT'

200

401

200

{
  "msg": "OK",
  "code": 0,
  "data": {
    "height": 1,
    "start": 1,
    "total": 1,
    "detail": [
      {
        "ticker": "text",
        "overallBalance": "text",
        "transferableBalance": "text",
        "availableBalance": "text"
      }
    ]
  }
}

Successful operation

Obtain BRC20 token summary by address, including available balance, transferable balance

get

/v1/indexer/address/{address}/brc20/summary-by-height/{height}

Authorizations

Path parameters

addressstringrequired

Address

heightstringrequired

Block Height

Query parameters

startintegerrequired

Start offset

Example: 0

limitintegerrequired

Number of inscriptions returned

Example: 16

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://open-api.unisat.io/v1/indexer/address/{address}/brc20/summary-by-height/{height}?start=1&limit=1' \
  --header 'Authorization: Bearer JWT'

200

401

200

{
  "msg": "OK",
  "code": 0,
  "data": {
    "height": 1,
    "start": 1,
    "total": 1,
    "detail": [
      {
        "ticker": "text",
        "overallBalance": "text",
        "transferableBalance": "text",
        "availableBalance": "text"
      }
    ]
  }
}

Successful operation

Each ticker includes two types of balances:

• transferableBalance: The balance already inscribed as TRANSFER inscriptions

• availableBalance: The balance can be inscribed as TRANSFER inscriptions

• overallBalance = transferableBalance+availableBalance