Parameters
- xpub_or_descriptorstringREQUIRED
An address, an extended public key, or an output descriptor wrapping an extended public key. Supported descriptor form:
pkh(...). Extended public keys must be account-level keys, not master keys.
Descriptors containing a / are not supported and return an error.
This includes:
- key origin prefixes:
pkh([73c5da0a/44'/145'/0']xpub...) - multipath selectors:
pkh(xpub.../<0;1>/*) - explicit branch paths:
pkh(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 - pkh(xpub...) - which is fully supported. The branch selector is unnecessary: Blockbook automatically scans both the receive (0) and change (1) branches for the account.
- objectobject
The options object with the following fields:
- confirmedboolean
Whether or not to exclude unconfirmed transactions.
- gapinteger
The gap limit used when deriving addresses from an extended public key (xpub). Defaults to 20.
Returns
- txarray
An array of unspent transaction outputs for an address or xpub, applicable only for Bitcoin-type coins. By default, the list contains both confirmed and unconfirmed transactions.
- txidstring
The transaction id
- voutinteger
The 4-byte index indicating the position of a transaction output
- valuestring
The value in satoshis of the output
- confirmationsinteger
The number of block confirmations since the output was created
- heightinteger
The block height at which the transaction output was created
- 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/44'/145'/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"id": 1,3"result": [4{5"txid": "3e5a53348fcac5459d82eedef9ce8b59694a23fa8cc7f00226ad06335f608742",6"vout": 2,7"value": "9897005",8"height": 916715,9"confirmations": 110},11{12"txid": "7d51c4e81679c3eced85fd7a3f6ab79cfffbc77b63d1c70759dbb94b000110e0",13"vout": 2,14"value": "1951",15"height": 916286,16"confirmations": 43017},18{19"txid": "0406af511e0b5e3cbb4c8ccbbe89b7bf48489bbf5d77823d9ee184f2a9516e42",20"vout": 2,21"value": "1774",22"height": 916204,23"confirmations": 51224},25{26"txid": "cd4a526f972b4942c68de2c57d9efdf11db8653cacd2baff9c3f34b902370c60",27"vout": 2,28"value": "1642",29"height": 916067,30"confirmations": 64931},32{33"txid": "842eb4b3146be5bd4f0c8b172dbac6e2a68e1217f20c040f97967ea78f0969af",34"vout": 2,35"value": "1539",36"height": 901527,37"confirmations": 1518938}39],40"jsonrpc": "2.0"41}
1{2"id": 1,3"result": [4{5"txid": "3e5a53348fcac5459d82eedef9ce8b59694a23fa8cc7f00226ad06335f608742",6"vout": 2,7"value": "9897005",8"height": 916715,9"confirmations": 110},11{12"txid": "7d51c4e81679c3eced85fd7a3f6ab79cfffbc77b63d1c70759dbb94b000110e0",13"vout": 2,14"value": "1951",15"height": 916286,16"confirmations": 43017},18{19"txid": "0406af511e0b5e3cbb4c8ccbbe89b7bf48489bbf5d77823d9ee184f2a9516e42",20"vout": 2,21"value": "1774",22"height": 916204,23"confirmations": 51224},25{26"txid": "cd4a526f972b4942c68de2c57d9efdf11db8653cacd2baff9c3f34b902370c60",27"vout": 2,28"value": "1642",29"height": 916067,30"confirmations": 64931},32{33"txid": "842eb4b3146be5bd4f0c8b172dbac6e2a68e1217f20c040f97967ea78f0969af",34"vout": 2,35"value": "1539",36"height": 901527,37"confirmations": 1518938}39],40"jsonrpc": "2.0"41}