# Bitcoin Address Summary

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

## GET /v1/bitcoin/address/{address}/summary

> Get address summary including paginated transaction IDs and balance information.\
>           This endpoint is mempool-aware and includes both confirmed and unconfirmed data.\
> &#x20;         \<br>\<br>\
> &#x20;         \<b>Response fields:\</b>\
> &#x20;         \<ul>\
> &#x20;           \<li>\<code>txids\</code> - Paginated list of transaction IDs for this address, ordered by block height\
> &#x20;           descending.\
> &#x20;           When there is mempool activity, unconfirmed transactions appear first.\</li>\
> &#x20;           \<li>\<code>confirmedBalance\</code> - Current confirmed balance in satoshis, ignoring mempool activity.\</li>\
> &#x20;           \<li>\<code>unconfirmedBalance\</code> - Net unconfirmed balance change (received - sent) in satoshis.\
> &#x20;           It can be negative as it only considers mempool, eg. when spending more than receiving.\</li>\
> &#x20;           \<li>\<code>offset\</code> - Current pagination offset.\</li>\
> &#x20;           \<li>\<code>limit\</code> - Current pagination limit.\</li>\
> &#x20;         \</ul>\
> &#x20;         \<br>\
> &#x20;        &#x20;

```json
{"openapi":"3.0.3","info":{"title":"SecretKeyLabs API","version":"1.0.0"},"tags":[{"name":"Bitcoin"}],"servers":[{"url":"https://api.secretkeylabs.io"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","name":"x-api-key","in":"header"}}},"paths":{"/v1/bitcoin/address/{address}/summary":{"get":{"tags":["Bitcoin"],"description":"Get address summary including paginated transaction IDs and balance information.\n          This endpoint is mempool-aware and includes both confirmed and unconfirmed data.\n          <br><br>\n          <b>Response fields:</b>\n          <ul>\n            <li><code>txids</code> - Paginated list of transaction IDs for this address, ordered by block height\n            descending.\n            When there is mempool activity, unconfirmed transactions appear first.</li>\n            <li><code>confirmedBalance</code> - Current confirmed balance in satoshis, ignoring mempool activity.</li>\n            <li><code>unconfirmedBalance</code> - Net unconfirmed balance change (received - sent) in satoshis.\n            It can be negative as it only considers mempool, eg. when spending more than receiving.</li>\n            <li><code>offset</code> - Current pagination offset.</li>\n            <li><code>limit</code> - Current pagination limit.</li>\n          </ul>\n          <br>\n          ","parameters":[{"schema":{"default":0,"minimum":0,"multipleOf":25,"type":"number"},"in":"query","name":"offset","required":false},{"schema":{"default":25,"minimum":25,"maximum":25,"type":"number"},"in":"query","name":"limit","required":false},{"schema":{"minLength":10,"default":"bc1q0egjvlcfq77cxd9kvpgppyuxckzvws46e3sxch","format":"BitcoinAddress","type":"string"},"in":"path","name":"address","required":true}],"responses":{"200":{"description":"Address summary with txids and balance","content":{"application/json":{"schema":{"description":"Address summary with txids and balance","type":"object","properties":{"txids":{"type":"array","items":{"type":"string"}},"confirmedBalance":{"type":"string"},"unconfirmedBalance":{"type":"string"},"offset":{"type":"number"},"limit":{"type":"number"}},"required":["txids","confirmedBalance","unconfirmedBalance","offset","limit"]}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"description":"Invalid input","type":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Unauthorized","type":"string"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Not found","type":"string"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"description":"Rate limit exceeded","type":"string"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"description":"Internal server error","type":"string"}}}}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.xverse.app/api/bitcoin/address/bitcoin-address-summary.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.