listunspent - Bitcoin RPC
listunspent ( minconf maxconf ["addresses",...] [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" (string) A json array of bitcoin addresses to filter [ "address" (string) bitcoin address ,... ] 4. include_unsafe (bool, optional, default=true) Include outputs that are not safe to spend See description of "safe" attribute below. 5. query_options (json, optional) JSON with query options { "minimumAmount" (numeric or string, default=0) Minimum value of each UTXO in BTC "maximumAmount" (numeric or string, default=unlimited) Maximum value of each UTXO in BTC "maximumCount" (numeric or string, default=unlimited) Maximum number of UTXOs "minimumSumAmount" (numeric or string, default=unlimited) Minimum sum value of all UTXOs in BTC } Result [ (array of json object) { "txid" : "txid", (string) the transaction id "vout" : n, (numeric) the vout value "address" : "address", (string) the bitcoin address "account" : "account", (string) DEPRECATED. The associated account, or "" for the default account "scriptPubKey" : "key", (string) the script key "amount" : x.xxx, (numeric) the transaction output amount in BTC "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 and unconfirmed replacement transactions 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/
This is a website, created out of frustration with uncomplete and outdated Bitcoin Core RPC documentation online.
It was inspired by ChainQuery, which seems to be abandoned. These docs are even simplier, so they can be regenerated by anyone.
Made by @karel_3d; license of the docs is MIT (see bitcoin repo), license of the scripts and webpage is also MIT ((C) 2018 Karel Bilek) (github repo)
Bitcoin version: 0.16.0.
Note that the RPC is from a regtest node (for completeness), so it includes some additional calls that a regular node doesn't have.
Blockchain
getbestblockhash
getblock
getblockchaininfo
getblockcount
getblockhash
getblockheader
getchaintips
getchaintxstats
getdifficulty
getmempoolancestors
getmempooldescendants
getmempoolentry
getmempoolinfo
getrawmempool
gettxout
gettxoutproof
gettxoutsetinfo
preciousblock
pruneblockchain
savemempool
verifychain
verifytxoutproof
getblock
getblockchaininfo
getblockcount
getblockhash
getblockheader
getchaintips
getchaintxstats
getdifficulty
getmempoolancestors
getmempooldescendants
getmempoolentry
getmempoolinfo
getrawmempool
gettxout
gettxoutproof
gettxoutsetinfo
preciousblock
pruneblockchain
savemempool
verifychain
verifytxoutproof
Control
Generating
Network
Rawtransactions
Util
Wallet
abandontransaction
abortrescan
addmultisigaddress
backupwallet
bumpfee
dumpprivkey
dumpwallet
encryptwallet
getaccount
getaccountaddress
getaddressesbyaccount
getbalance
getnewaddress
getrawchangeaddress
getreceivedbyaccount
getreceivedbyaddress
gettransaction
getunconfirmedbalance
getwalletinfo
importaddress
importmulti
importprivkey
importprunedfunds
importpubkey
importwallet
keypoolrefill
listaccounts
listaddressgroupings
listlockunspent
listreceivedbyaccount
listreceivedbyaddress
listsinceblock
listtransactions
listunspent
listwallets
lockunspent
move
removeprunedfunds
rescanblockchain
sendfrom
sendmany
sendtoaddress
setaccount
settxfee
signmessage
walletlock
walletpassphrase
walletpassphrasechange
abortrescan
addmultisigaddress
backupwallet
bumpfee
dumpprivkey
dumpwallet
encryptwallet
getaccount
getaccountaddress
getaddressesbyaccount
getbalance
getnewaddress
getrawchangeaddress
getreceivedbyaccount
getreceivedbyaddress
gettransaction
getunconfirmedbalance
getwalletinfo
importaddress
importmulti
importprivkey
importprunedfunds
importpubkey
importwallet
keypoolrefill
listaccounts
listaddressgroupings
listlockunspent
listreceivedbyaccount
listreceivedbyaddress
listsinceblock
listtransactions
listunspent
listwallets
lockunspent
move
removeprunedfunds
rescanblockchain
sendfrom
sendmany
sendtoaddress
setaccount
settxfee
signmessage
walletlock
walletpassphrase
walletpassphrasechange