Skip to content

listunspent JSON-RPC command

listunspent ( minconf maxconf ["address",...] include_unsafe query_options )

Returns array of unspent transaction outputs with between minconf and maxconf (inclusive) confirmations. Optionally filter to only include txouts paid to specified addresses.

Arguments

``` 1. minconf (numeric, optional, default=1) The minimum confirmations to filter 2. maxconf (numeric, optional, default=9999999) The maximum confirmations to filter 3. addresses (json array, optional) A json array of Bitcoin Cash addresses to filter [ "address", (string) Bitcoin Cash address ... ] 4. include_unsafe (boolean, optional, default=true) Include outputs that are not safe to spend See description of "safe" attribute below. 5. query_options (json object, optional) JSON with query options { "minimumAmount": amount, (numeric or string, optional, default=0) Minimum value of each UTXO in BCH "maximumAmount": amount, (numeric or string, optional, default=unlimited) Maximum value of each UTXO in BCH "maximumCount": n, (numeric, optional, default=unlimited) Maximum number of UTXOs "minimumSumAmount": amount, (numeric or string, optional, default=unlimited) Minimum sum value of all UTXOs in BCH "includeTokens": bool, (boolean, optional, default=false) Whether to show UTXOs with CashTokens on them "tokensOnly": bool, (boolean, optional, default=false) Whether to only show UTXOs with CashTokens on them (implies includeTokens=true) }

Result [ (array of json object) { "txid" : "txid", (string) the transaction id "vout" : n, (numeric) the vout value "address" : "address", (string) the Bitcoin Cash address "label" : "label", (string) The associated label, or "" for the default label "scriptPubKey" : "key", (string) the script key "amount" : x.xxx, (numeric) the transaction output amount in BCH "tokenData" : { ... }, (object optional) token data "confirmations" : n, (numeric) The number of confirmations "redeemScript" : n (string) The redeemScript if scriptPubKey is P2SH "spendable" : xxx, (bool) Whether we have the private keys to spend this output "solvable" : xxx, (bool) Whether we know how to spend this output, ignoring the lack of keys "safe" : xxx (bool) Whether this output is considered safe to spend. Unconfirmed transactions from outside keys are considered unsafe and are not eligible for spending by fundrawtransaction and sendtoaddress. } ,... ]

Examples

bitcoin-cli listunspent bitcoin-cli listunspent 6 9999999 "[\"1PGFqEzfmQch1gKD3ra4k18PNj3tTUUSqg\",\"1LtvqCaApEdUGFkpKMM4MstjcaL4dKg8SP\"]" curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listunspent", "params": [6, 9999999 "[\"1PGFqEzfmQch1gKD3ra4k18PNj3tTUUSqg\",\"1LtvqCaApEdUGFkpKMM4MstjcaL4dKg8SP\"]"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ bitcoin-cli listunspent 6 9999999 '[]' true '{ "minimumAmount": 0.005 }' curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listunspent", "params": [6, 9999999, [] , true, { "minimumAmount": 0.005 } ] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ ```

Bitcoin Cash Node Daemon version v29.0.1-71febb2

Documentation on docs.bitcoincashnode.org reflects the current master branch in Git, and may include API changes that are not yet present in the latest release.