Path Parameters
- xpub_or_addressstringREQUIRED
An address, an extended public key, or an output descriptor. Supported descriptor forms:
pkh(...),wpkh(...),sh(wpkh(...)), andtr(...). Must be an account-level key, not a master key. URL-encode the descriptor when placing it in the REST path.
Descriptors containing a / are not supported and return an error.
This includes:
- key origin prefixes:
tr([73c5da0a/86'/0'/0']xpub...) - multipath selectors:
tr(xpub.../<0;1>/*) - explicit branch paths:
tr(xpub.../0/*)
Percent-encoding the slash does not help. Note the origin prefix cannot be shortened either, since it contains slashes of its own.
Use the bare form instead - tr(xpub...) - which is fully supported. The branch selector is unnecessary: Blockbook automatically scans both the receive (0) and change (1) branches for the account.
Query Parameters
- confirmedboolean
When set to true, only returns confirmed UTXOs.
- gapinteger
The gap limit used when deriving addresses from an extended public key (xpub). Defaults to 20.
Returns
- txidstring
Transaction ID of the UTXO
- voutinteger
Output index in the transaction
- valuestring
UTXO value in satoshis
- heightinteger
Block height where the UTXO was created
- confirmationsinteger
Number of confirmations
- addressstring
The address this UTXO belongs to. Returned only for xpub and descriptor queries; omitted for single-address queries.
- pathstring
BIP32 derivation path of the address, e.g.
m/86'/0'/0'/0/0. The last two segments are the branch (0 = receive, 1 = change) and the address index. Returned only for xpub and descriptor queries; omitted for single-address queries.
1[2{3"txid": "959bb7b066f8e8cfccb6f089eccdc1d1d84ed5199a2d35771465b2558e2d5339",4"vout": 1,5"value": "330078393",6"height": 952895,7"confirmations": 18},9{10"txid": "c301490a0b821c5182010d0c178e538c127bb251fb62d5b39414a7c260b8e681",11"vout": 1,12"value": "331021333",13"height": 952895,14"confirmations": 115}16]
1[2{3"txid": "959bb7b066f8e8cfccb6f089eccdc1d1d84ed5199a2d35771465b2558e2d5339",4"vout": 1,5"value": "330078393",6"height": 952895,7"confirmations": 18},9{10"txid": "c301490a0b821c5182010d0c178e538c127bb251fb62d5b39414a7c260b8e681",11"vout": 1,12"value": "331021333",13"height": 952895,14"confirmations": 115}16]