[v2] Rune Balances (Mempool-Aware)

get

Get confirmed and unconfirmed runes balance. balance fields explained:

• confirmedBalance is the rune balance ignoring unconfirmed transactions in mempool.

• availableBalance is the confirmed balance minus amounts used by any outgoing unconfirmed transaction in mempool.

• projectedBalance is the final balance if all unconfirmed mempool transactions are confirmed.

• pendingBalance is a breakdown of the unconfirmed transactions amounts. They represent aggregate amounts for the whole mempool activity, so as more transactions are chained together the amounts will increase.

  • incomingAmount is the sum of all incoming unconfirmed amounts.

  • outgoingAmount is the sum of all outgoing unconfirmed amounts.

  • netAmount is incoming - outgoing. The netAmount can be negative, when sending more than receiving. It should always match what is expected to be added to the confirmed balance when all unconfirmed transactions are confirmed, which is computed as projectedBalance for convenience.

Authorizations

apiKey

x-api-keystringRequired

Path parameters

addressstring · BitcoinAddress · min: 10RequiredDefault: bc1q0egjvlcfq77cxd9kvpgppyuxckzvws46e3sxch

Query parameters

runeIdstringOptional

includePricingbooleanOptional

Responses

200

Default Response

application/json

indexerHeightnumberRequired

Last height indexed by the runes indexer

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

/v2/runes/address/{address}/balance

HTTPcURLJavaScriptPython

GET /v2/runes/address/{address}/balance HTTP/1.1
Host: api.secretkeylabs.io
x-api-key: YOUR_API_KEY
Accept: */*

{
  "balances": [
    {
      "runeId": "text",
      "divisibility": 1,
      "symbol": "text",
      "runeName": "text",
      "confirmedBalance": "text",
      "availableBalance": "text",
      "projectedBalance": "text",
      "pendingBalance": {
        "incomingAmount": "text",
        "outgoingAmount": "text",
        "netAmount": "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"
      }
    }
  ],
  "indexerHeight": 1
}