Get BRC-20 balances

Retrieves BRC-20 token balances for a Bitcoin address.

GET
/ordinals/v1/brc-20/balances/{address}

BRC-20 Balances

Retrieves BRC-20 token balances for a Bitcoin address

Query Parameters

tickerarray<string>

block_heightBlock Height

Bitcoin block height

Pattern: "^[0-9]+$"

offsetOffset

Result offset

Minimum: 0

limitLimit

Results per page

Minimum: 1Maximum: 60

Path Parameters

address
Required
Address

Bitcoin address

Status codeDescription
200Default Response
/ordinals/v1/brc-20/balances/{address}

curl -X GET "https://api.hiro.so/ordinals/v1/brc-20/balances/string?ticker=%5B%0A++%22string%22%0A%5D&block_height=string&offset=0&limit=1"

{
"limit": 20,
"offset": 0,
"total": 1,
"results": [
{
"ticker": "PEPE",
"available_balance": "1500.00000",
"transferrable_balance": "500.00000",
"overall_balance": "2000.00000"
}
]
}