Get Address BRC-20 Summary

get

https://open-api.unisat.iohttps://open-api-s1.unisat.iohttps://open-api-testnet.unisat.io

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

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

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

addressstringRequired

Address

Query parameters

startintegerRequired

Start offset

Example: 0

limitintegerRequired

Number of inscriptions returned

Example: 16

Responses

200

Successful operation

application/json

401

Invalid API Key

get

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

HTTPcURLJavaScriptPython

GET /v1/indexer/address/{address}/brc20/summary?start=1&limit=1 HTTP/1.1
Host: open-api.unisat.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

get

https://open-api.unisat.iohttps://open-api-s1.unisat.iohttps://open-api-testnet.unisat.io

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

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

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

401

Invalid API Key

get

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

HTTPcURLJavaScriptPython

GET /v1/indexer/address/{address}/brc20/summary-by-height/{height}?start=1&limit=1 HTTP/1.1
Host: open-api.unisat.io
Authorization: Bearer YOUR_SECRET_TOKEN
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