Get Address BRC-20 Summary

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

GEThttps://open-api.unisat.io/v1/indexer/address/{address}/brc20/summary

Path parameters

address*string

Address

Query parameters

Response

200401

Successful operation

Body

application/json

codeenum

0-1

msgstring

dataobject

Request

JavaScriptCurl

const response = await fetch('https://open-api.unisat.io/v1/indexer/address/{address}/brc20/summary', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

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

GEThttps://open-api.unisat.io/v1/indexer/address/{address}/brc20/summary-by-height/{height}

Path parameters

address*string

Address

height*string

Block Height

Query parameters

Response

200401

Successful operation

Body

application/json

codeenum

0-1

msgstring

dataobject

Request

JavaScriptCurl

const response = await fetch('https://open-api.unisat.io/v1/indexer/address/{address}/brc20/summary-by-height/{height}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

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