BRC-20 balances

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

apiKey

x-api-keystringRequired

Path parameters

addressstring · BitcoinAddress · min: 10RequiredDefault: bc1q0egjvlcfq77cxd9kvpgppyuxckzvws46e3sxch

Query parameters

offsetnumberOptionalDefault: 0

limitnumber · min: 25 · max: 60OptionalDefault: 60

tickerstringOptional

includePricingbooleanOptional

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

/v1/ordinals/address/{address}/brc20

HTTPcURLJavaScriptPython

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",
      "overallBalance": "text",
      "transferableBalance": "text",
      "availableBalance": "text",
      "prices": {
        "floorPrice": {
          "marketplace": "text",
          "percentageChange24h": {
            "valueInSats": "text",
            "valueInUsd": "text"
          },
          "valueInSats": "text",
          "valueInUsd": "text"
        },
        "lastSalePrice": {
          "marketplace": "text",
          "valueInSats": "text",
          "valueInUsd": "text"
        }
      },
      "volume24h": {
        "percentageChange": {
          "valueInSats": "text",
          "valueInUsd": "text"
        },
        "valueInSats": "text",
        "valueInUsd": "text"
      }
    }
  ]
}