Get balance by address#
Get BRC20 balance by btc address, returns a json object with the BRC20 balance info.
Request address#
GET http://{ip}:{port}/api/v1/brc20/address/{address}/balance
Request param#
| Parameter | Type | Description | Notes |
|---|---|---|---|
| address | String | The btc address. | [default to null] |
Response param#
| Parameter | Type | Description |
|---|---|---|
| code | Integer | The response code. |
| msg | String | A message describing the error. |
| data | Object | It is a object with the balance info. |
| > tokens | Array | The balance info list. |
| >> tick | String | The tick name. |
| >> availableBalance | Number | The available balance. |
| >> transferableBalance | Number | The transferable balance. |
| >> overallBalance | Number | The overall balance. |
Request example#
shell
curl --location --request GET 'http://{ip}:{port}/api/v1/brc20/address/bc1pxl55h9yhj6v3uuwx7njp3gyqdd8fv0erya8qfj5dnuuy92jdzmmsjjjl6w/balance'
Response example#
200
{
"code": 0,
"msg": "ok",
"data": {
"balance": [
{
"tick": "bip1",
"availableBalance": "2162658592280000000000000",
"transferableBalance": "0",
"overallBalance": "2162658592280000000000000"
},
{
"tick": "insc",
"availableBalance": "1000000000000000000",
"transferableBalance": "0",
"overallBalance": "1000000000000000000"
},
{
"tick": "meme",
"availableBalance": "1152132635400000000000",
"transferableBalance": "0",
"overallBalance": "1152132635400000000000"
},
{
"tick": "nals",
"availableBalance": "1814212314700200000000000",
"transferableBalance": "0",
"overallBalance": "1814212314700200000000000"
},
{
"tick": "ordi",
"availableBalance": "275188774454000000000000",
"transferableBalance": "0",
"overallBalance": "275188774454000000000000"
},
{
"tick": "pepe",
"availableBalance": "388116750590000000000000",
"transferableBalance": "0",
"overallBalance": "388116750590000000000000"
},
{
"tick": "piza",
"availableBalance": "932426466121100000000000",
"transferableBalance": "0",
"overallBalance": "932426466121100000000000"
},
{
"tick": "vmpx",
"availableBalance": "1394496080039700000000000",
"transferableBalance": "0",
"overallBalance": "1394496080039700000000000"
}
]
}
}