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'/133'/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
- resultarray
An array of unspent transaction outputs for an address or xpub. 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 zatoshis of the output
- heightinteger
The block height at which the transaction output was created
- confirmationsinteger
The number of block confirmations since the output was created
- coinbaseboolean
Whether the UTXO is a Coinbase transaction. Coinbase UTXOs have this field set to true, however, due to performance reasons, it will return only up to the minimum Coinbase confirmations limit (100). After this limit, UTXOs are not detected as Coinbase.
- addressstring
(Optional) The address this UTXO belongs to; included for xpub and descriptor queries, omitted for single-address queries
- pathstring
(Optional) BIP32 derivation path of the address (e.g. m/44'/133'/0'/0/0); included for xpub and descriptor queries, omitted for single-address queries
1{2"id": 1,3"result": [4{5"txid": "65c2220429d7858d42ca8741cb4170f64660bf189b9aeb82f13dd6cbbfb316ce",6"vout": 0,7"value": "125075000",8"height": 3325978,9"confirmations": 92,10"coinbase": true11},12{13"txid": "c7a5aba940d88b4a54c4e42350fc6d5f7af025e692c8ce5da932ab9c80306dcb",14"vout": 0,15"value": "125221500",16"height": 3325941,17"confirmations": 12918},19{20"txid": "a11a005fa3bb17143122160b8073b3eb6ae2f511b6e2ea3f194b628c8b2ebead",21"vout": 0,22"value": "125000000",23"height": 3325940,24"confirmations": 13025}26],27"jsonrpc": "2.0"28}
1{2"id": 1,3"result": [4{5"txid": "65c2220429d7858d42ca8741cb4170f64660bf189b9aeb82f13dd6cbbfb316ce",6"vout": 0,7"value": "125075000",8"height": 3325978,9"confirmations": 92,10"coinbase": true11},12{13"txid": "c7a5aba940d88b4a54c4e42350fc6d5f7af025e692c8ce5da932ab9c80306dcb",14"vout": 0,15"value": "125221500",16"height": 3325941,17"confirmations": 12918},19{20"txid": "a11a005fa3bb17143122160b8073b3eb6ae2f511b6e2ea3f194b628c8b2ebead",21"vout": 0,22"value": "125000000",23"height": 3325940,24"confirmations": 13025}26],27"jsonrpc": "2.0"28}