LogoLogo
  • Xverse API
  • โ–ถ๏ธGet Started
  • ๐Ÿ“šAPI reference
    • Bitcoin
      • ๐Ÿ“ฆOutputs
      • ๐Ÿ“ซAddress
        • UTXO
        • Balance
        • Transactions
          • Unconfirmed
      • ๐Ÿ“Transactions
        • History
    • ๐Ÿ–ผ๏ธOrdinals
      • Address
        • ๐Ÿ“ฆUTXO
        • ๐Ÿ–ผ๏ธInscriptions
        • ๐Ÿ”ณRunes
        • ๐Ÿช™BRC-20
      • โœ๏ธInscription Service
        • Estimate
        • Order
          • Execute
    • ๐Ÿ”ฒRunes
      • Rune balances
      • โ›๏ธMint Rune
        • Estimate
        • Order
          • Execute
      • ๐Ÿš€Etch Rune
        • Estimate
        • Order
          • Execute
      • ๐Ÿ”ฒRune Data
    • ๐Ÿช™BRC-20
      • ๐Ÿช™BRC-20 balances
      • โ›๏ธMint BRC-20
        • Estimate
        • Order
          • Execute
      • ๐Ÿš€Deploy BRC-20
        • Estimate
        • Order
          • Execute
    • ๐Ÿ”„Swaps
      • ๐Ÿช™Get destination tokens
      • ๐ŸงพGet quotes
      • ๐Ÿ”ฒRunes Swaps
        • Place order
        • Execute order
      • ๐Ÿ“ฆUTXO
        • Get utxos
        • Place order
        • Execute order
      • ๐Ÿ”ดStacks Swaps
        • Place order
        • Execute order
      • ๐Ÿ”€Crosschain Swaps
        • Place order
  • Specification
Powered by GitBook
On this page
Export as PDF
  1. API reference
  2. BRC-20

BRC-20 balances

PreviousBRC-20NextMint BRC-20
๐Ÿ“š
๐Ÿช™
๐Ÿช™
get

Fetch confirmed BRC-20 balances belonging to an address.Note: The Api response includes limit & offset for future pagination extension, but at the moment query parameters are ignored and the response is always the full list. So, limit equals the total items number, be sure to handle pagination as the limit can change once pagination is implemented.

Authorizations
Path parameters
addressstring ยท BitcoinAddress ยท min: 10RequiredDefault: bc1q0egjvlcfq77cxd9kvpgppyuxckzvws46e3sxch
Query parameters
offsetnumberOptionalDefault: 0
limitnumber ยท min: 25 ยท max: 60OptionalDefault: 60
Responses
200
BRC20 balances for all utxos belonging to the address
application/json
400
Invalid input
application/json
401
Unauthorized
application/json
404
Not found
application/json
429
Rate limit exceeded
application/json
500
Internal server error
application/json
get
GET /v1/ordinals/address/{address}/brc20 HTTP/1.1
Host: api.secretkeylabs.io
x-api-key: YOUR_API_KEY
Accept: */*
{
  "limit": 1,
  "offset": 1,
  "total": 1,
  "items": [
    {
      "ticker": "text",
      "amount": "text"
    }
  ]
}