Bitcoin Address Summary

Returns the balance and a paginated list of transaction IDs for a given Bitcoin address. Fully mempool-aware.

get

Get address summary including paginated transaction IDs and balance information. This endpoint is mempool-aware and includes both confirmed and unconfirmed data. Response fields:

• txids - Paginated list of transaction IDs for this address, ordered by block height descending. When there is mempool activity, unconfirmed transactions appear first.

• confirmedBalance - Current confirmed balance in satoshis, ignoring mempool activity.

• unconfirmedBalance - Net unconfirmed balance change (received - sent) in satoshis. It can be negative as it only considers mempool, eg. when spending more than receiving.

• offset - Current pagination offset.

• limit - Current pagination limit.

Authorizations

apiKey

x-api-keystringRequired

Path parameters

addressstring · BitcoinAddress · min: 10RequiredDefault: bc1q0egjvlcfq77cxd9kvpgppyuxckzvws46e3sxch

Query parameters

offsetnumberOptionalDefault: 0

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

Responses

200

Address summary with txids and balance

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/bitcoin/address/{address}/summary

HTTPcURLJavaScriptPython

GET /v1/bitcoin/address/{address}/summary HTTP/1.1
Host: api.secretkeylabs.io
x-api-key: YOUR_API_KEY
Accept: */*

{
  "txids": [
    "text"
  ],
  "confirmedBalance": "text",
  "unconfirmedBalance": "text",
  "offset": 1,
  "limit": 1
}