Get Address BRC-20 Summary

get

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

Authorizations
Path parameters
addressstringRequired

Address

Query parameters
startintegerRequired

Start offset

Example: 0
limitintegerRequired

Number of inscriptions returned

Example: 16
Responses
200
Successful operation
application/json
get
GET /v1/indexer/address/{address}/brc20/summary HTTP/1.1
Host: open-api.unisat.io
Authorization: Bearer JWT
Accept: */*

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

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

Authorizations
Path parameters
addressstringRequired

Address

heightstringRequired

Block Height

Query parameters
startintegerRequired

Start offset

Example: 0
limitintegerRequired

Number of inscriptions returned

Example: 16
Responses
200
Successful operation
application/json
get
GET /v1/indexer/address/{address}/brc20/summary-by-height/{height} HTTP/1.1
Host: open-api.unisat.io
Authorization: Bearer JWT
Accept: */*

{
  "code": 0,
  "msg": "OK",
  "data": {
    "height": 1,
    "start": 1,
    "total": 1,
    "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

PreviousGet BRC-20 Tx HistoryNextGet Address BRC-20 Ticker Info

Last updated