RPC developer docs for HUSH full node
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

749 lines
25 KiB

<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=1200px, shrink-to-fit=yes">
<meta name="description" content="Hush 3.10.2 RPC Docs - z_listunspent">
<meta name="author" content="">
<title>z_listunspent - Hush 3.10.2 RPC Docs</title>
<link href="./bootstrap.min.css" rel="stylesheet">
</head>
<style>
.card-body {
font-size:80%;
padding-top: 0.5em;
}
pre {
word-break: break-word;
white-space: pre-wrap;
}
</style>
<body>
<nav class="navbar navbar-dark bg-dark ">
<a class="navbar-brand" href="/">Hush 3.10.2 RPC docs</a>
</nav>
<main role="main" class="container-fluid" style="margin-top: 1pc;">
<div class="row">
<div class="col-8 col-lg-9 col-xl-10">
<h1>z_listunspent - Hush 3.10.2 RPC</h1>
<pre>z_listunspent ( minconf maxconf includeWatchonly [&#34;zaddr&#34;,...] )
Returns array of unspent shielded notes with between minconf and maxconf (inclusive) confirmations.
Optionally filter to only include notes sent to specified addresses.
When minconf is 0, unspent notes with zero confirmations are returned, even though they are not immediately spendable.
Results are an array of Objects, each of which has:
{txid, outindex, confirmations, address, amount, memo}
Arguments:
1. minconf (numeric, optional, default=1) The minimum confirmations to filter
2. maxconf (numeric, optional, default=9999999) The maximum confirmations to filter
3. includeWatchonly (bool, optional, default=false) Also include watchonly addresses (see &#39;z_importviewingkey&#39;)
4. &#34;addresses&#34; (string) A json array of zaddrs to filter on. Duplicate addresses not allowed.
[
&#34;address&#34; (string) zaddr
,...
]
Result
[ (array of json object)
{
&#34;txid&#34; : &#34;txid&#34;, (string) the transaction id
&#34;outindex&#34; (sapling) : n (numeric) the output index
&#34;confirmations&#34; : n (numeric) the number of confirmations
&#34;spendable&#34; : true|false (boolean) true if note can be spent by wallet, false if note has zero confirmations, false if address is watchonly
&#34;address&#34; : &#34;address&#34;, (string) the shielded address
&#34;amount&#34;: xxxxx, (numeric) the amount of value in the note
&#34;memo&#34;: xxxxx, (string) hexademical string representation of memo field
&#34;memoStr&#34; : &#34;memo&#34;, (string) Only returned if memo contains valid UTF-8 text.
&#34;change&#34;: true|false, (boolean) true if the address that received the note is also one of the sending addresses
}
,...
]
Examples
&gt; hush-cli z_listunspent
&gt; hush-cli z_listunspent 6 9999999 false &#34;[\&#34;zs14d8tc0hl9q0vg5l28uec5vk6sk34fkj2n8s7jalvw5fxpy6v39yn4s2ga082lymrkjk0x2nqg37\&#34;,\&#34;zs14d8tc0hl9q0vg5l28uec5vk6sk34fkj2n8s7jalvw5fxpy6v39yn4s2ga082lymrkjk0x2nqg37\&#34;]&#34;
&gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;z_listunspent&#34;, &#34;params&#34;: [6,9999999,false,[&#34;zs14d8tc0hl9q0vg5l28uec5vk6sk34fkj2n8s7jalvw5fxpy6v39yn4s2ga082lymrkjk0x2nqg37&#34;,&#34;zs14d8tc0hl9q0vg5l28uec5vk6sk34fkj2n8s7jalvw5fxpy6v39yn4s2ga082lymrkjk0x2nqg37&#34;]] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:18031/
</pre>
<hr>
<p>
Maintained by <a href="https://git.hush.is">The Hush Developers</a>
</p>
<p>
Welcome to the Hush full node RPC developer documentation!!! You finally made it.
</p>
</div>
<div class="col-4 col-lg-3 col-xl-2">
<div class="card">
<div class="card-header">
Addressindex
</div>
<div class="card-body">
<a href="checknotarization.html">checknotarization</a>
<br>
<a href="getaddressbalance.html">getaddressbalance</a>
<br>
<a href="getaddressdeltas.html">getaddressdeltas</a>
<br>
<a href="getaddressmempool.html">getaddressmempool</a>
<br>
<a href="getaddresstxids.html">getaddresstxids</a>
<br>
<a href="getaddressutxos.html">getaddressutxos</a>
<br>
<a href="getnotarypayinfo.html">getnotarypayinfo</a>
<br>
<a href="getsnapshot.html">getsnapshot</a>
<br>
</div>
</div>
<br>
<div class="card">
<div class="card-header">
Blockchain
</div>
<div class="card-body">
<a href="coinsupply.html">coinsupply</a>
<br>
<a href="getbestblockhash.html">getbestblockhash</a>
<br>
<a href="getblock.html">getblock</a>
<br>
<a href="getblockchaininfo.html">getblockchaininfo</a>
<br>
<a href="getblockcount.html">getblockcount</a>
<br>
<a href="getblockhash.html">getblockhash</a>
<br>
<a href="getblockhashes.html">getblockhashes</a>
<br>
<a href="getblockheader.html">getblockheader</a>
<br>
<a href="getblockmerkletree.html">getblockmerkletree</a>
<br>
<a href="getchaintips.html">getchaintips</a>
<br>
<a href="getchaintxstats.html">getchaintxstats</a>
<br>
<a href="getdifficulty.html">getdifficulty</a>
<br>
<a href="getmempoolinfo.html">getmempoolinfo</a>
<br>
<a href="getrawmempool.html">getrawmempool</a>
<br>
<a href="getspentinfo.html">getspentinfo</a>
<br>
<a href="gettxout.html">gettxout</a>
<br>
<a href="gettxoutproof.html">gettxoutproof</a>
<br>
<a href="gettxoutsetinfo.html">gettxoutsetinfo</a>
<br>
<a href="kvsearch.html">kvsearch</a>
<br>
<a href="kvupdate.html">kvupdate</a>
<br>
<a href="minerids.html">minerids</a>
<br>
<a href="notaries.html">notaries</a>
<br>
<a href="verifychain.html">verifychain</a>
<br>
<a href="verifytxoutproof.html">verifytxoutproof</a>
<br>
</div>
</div>
<br>
<div class="card">
<div class="card-header">
Control
</div>
<div class="card-body">
<a href="getdragonjson.html">getdragonjson</a>
<br>
<a href="geterablockheights.html">geterablockheights</a>
<br>
<a href="getinfo.html">getinfo</a>
<br>
<a href="getnotarysendmany.html">getnotarysendmany</a>
<br>
<a href="help.html">help</a>
<br>
<a href="stop.html">stop</a>
<br>
</div>
</div>
<br>
<div class="card">
<div class="card-header">
Crosschain
</div>
<div class="card-body">
<a href="MoMoMdata.html">MoMoMdata</a>
<br>
<a href="assetchainproof.html">assetchainproof</a>
<br>
<a href="calc_MoM.html">calc_MoM</a>
<br>
<a href="getNotarizationsForBlock.html">getNotarizationsForBlock</a>
<br>
<a href="height_MoM.html">height_MoM</a>
<br>
<a href="scanNotarizationsDB.html">scanNotarizationsDB</a>
<br>
</div>
</div>
<br>
<div class="card">
<div class="card-header">
Generating
</div>
<div class="card-body">
<a href="generate.html">generate</a>
<br>
<a href="getgenerate.html">getgenerate</a>
<br>
<a href="setgenerate.html">setgenerate</a>
<br>
</div>
</div>
<br>
<div class="card">
<div class="card-header">
Mining
</div>
<div class="card-body">
<a href="genminingCSV.html">genminingCSV</a>
<br>
<a href="getblocksubsidy.html">getblocksubsidy</a>
<br>
<a href="getblocktemplate.html">getblocktemplate</a>
<br>
<a href="getlocalsolps.html">getlocalsolps</a>
<br>
<a href="getmininginfo.html">getmininginfo</a>
<br>
<a href="getnetworkhashps.html">getnetworkhashps</a>
<br>
<a href="getnetworksolps.html">getnetworksolps</a>
<br>
<a href="prioritisetransaction.html">prioritisetransaction</a>
<br>
<a href="submitblock.html">submitblock</a>
<br>
</div>
</div>
<br>
<div class="card">
<div class="card-header">
NSPV
</div>
<div class="card-body">
<a href="nspv_broadcast.html">nspv_broadcast</a>
<br>
<a href="nspv_getinfo.html">nspv_getinfo</a>
<br>
<a href="nspv_hdrsproof.html">nspv_hdrsproof</a>
<br>
<a href="nspv_listccmoduleunspent.html">nspv_listccmoduleunspent</a>
<br>
<a href="nspv_listtransactions.html">nspv_listtransactions</a>
<br>
<a href="nspv_listunspent.html">nspv_listunspent</a>
<br>
<a href="nspv_login.html">nspv_login</a>
<br>
<a href="nspv_logout.html">nspv_logout</a>
<br>
<a href="nspv_mempool.html">nspv_mempool</a>
<br>
<a href="nspv_notarizations.html">nspv_notarizations</a>
<br>
<a href="nspv_spend.html">nspv_spend</a>
<br>
<a href="nspv_spentinfo.html">nspv_spentinfo</a>
<br>
<a href="nspv_txproof.html">nspv_txproof</a>
<br>
</div>
</div>
<br>
<div class="card">
<div class="card-header">
Network
</div>
<div class="card-body">
<a href="addnode.html">addnode</a>
<br>
<a href="clearbanned.html">clearbanned</a>
<br>
<a href="disconnectnode.html">disconnectnode</a>
<br>
<a href="getaddednodeinfo.html">getaddednodeinfo</a>
<br>
<a href="getconnectioncount.html">getconnectioncount</a>
<br>
<a href="getnettotals.html">getnettotals</a>
<br>
<a href="getnetworkinfo.html">getnetworkinfo</a>
<br>
<a href="getpeerinfo.html">getpeerinfo</a>
<br>
<a href="getpeerlist.html">getpeerlist</a>
<br>
<a href="listbanned.html">listbanned</a>
<br>
<a href="ping.html">ping</a>
<br>
<a href="setban.html">setban</a>
<br>
</div>
</div>
<br>
<div class="card">
<div class="card-header">
Rawtransactions
</div>
<div class="card-body">
<a href="createrawtransaction.html">createrawtransaction</a>
<br>
<a href="decoderawtransaction.html">decoderawtransaction</a>
<br>
<a href="decodescript.html">decodescript</a>
<br>
<a href="fundrawtransaction.html">fundrawtransaction</a>
<br>
<a href="getrawtransaction.html">getrawtransaction</a>
<br>
<a href="sendrawtransaction.html">sendrawtransaction</a>
<br>
<a href="signrawtransaction.html">signrawtransaction</a>
<br>
</div>
</div>
<br>
<div class="card">
<div class="card-header">
Stratum
</div>
<div class="card-body">
<a href="stratum_getclientscount.html">stratum_getclientscount</a>
<br>
<a href="stratum_getdifficulty.html">stratum_getdifficulty</a>
<br>
<a href="stratum_setdifficulty.html">stratum_setdifficulty</a>
<br>
<a href="stratum_updatework.html">stratum_updatework</a>
<br>
</div>
</div>
<br>
<div class="card">
<div class="card-header">
Util
</div>
<div class="card-body">
<a href="createmultisig.html">createmultisig</a>
<br>
<a href="estimatefee.html">estimatefee</a>
<br>
<a href="estimatepriority.html">estimatepriority</a>
<br>
<a href="invalidateblock.html">invalidateblock</a>
<br>
<a href="reconsiderblock.html">reconsiderblock</a>
<br>
<a href="rpcinfo.html">rpcinfo</a>
<br>
<a href="setmocktime.html">setmocktime</a>
<br>
<a href="txnotarizedconfirmed.html">txnotarizedconfirmed</a>
<br>
<a href="validateaddress.html">validateaddress</a>
<br>
<a href="verifymessage.html">verifymessage</a>
<br>
<a href="z_validateaddress.html">z_validateaddress</a>
<br>
</div>
</div>
<br>
<div class="card">
<div class="card-header">
Wallet
</div>
<div class="card-body">
<a href="abortrescan.html">abortrescan</a>
<br>
<a href="addmultisigaddress.html">addmultisigaddress</a>
<br>
<a href="backupwallet.html">backupwallet</a>
<br>
<a href="cleanwallettransactions.html">cleanwallettransactions</a>
<br>
<a href="convertpassphrase.html">convertpassphrase</a>
<br>
<a href="dumpprivkey.html">dumpprivkey</a>
<br>
<a href="dumpwallet.html">dumpwallet</a>
<br>
<a href="encryptwallet.html">encryptwallet</a>
<br>
<a href="getaccount.html">getaccount</a>
<br>
<a href="getaccountaddress.html">getaccountaddress</a>
<br>
<a href="getaddressesbyaccount.html">getaddressesbyaccount</a>
<br>
<a href="getalldata.html">getalldata</a>
<br>
<a href="getbalance.html">getbalance</a>
<br>
<a href="getnewaddress.html">getnewaddress</a>
<br>
<a href="getrawchangeaddress.html">getrawchangeaddress</a>
<br>
<a href="getreceivedbyaccount.html">getreceivedbyaccount</a>
<br>
<a href="getreceivedbyaddress.html">getreceivedbyaddress</a>
<br>
<a href="getrescaninfo.html">getrescaninfo</a>
<br>
<a href="gettransaction.html">gettransaction</a>
<br>
<a href="getunconfirmedbalance.html">getunconfirmedbalance</a>
<br>
<a href="getwalletinfo.html">getwalletinfo</a>
<br>
<a href="importaddress.html">importaddress</a>
<br>
<a href="importprivkey.html">importprivkey</a>
<br>
<a href="importwallet.html">importwallet</a>
<br>
<a href="keypoolrefill.html">keypoolrefill</a>
<br>
<a href="listaccounts.html">listaccounts</a>
<br>
<a href="listaddresses.html">listaddresses</a>
<br>
<a href="listaddressgroupings.html">listaddressgroupings</a>
<br>
<a href="listlockunspent.html">listlockunspent</a>
<br>
<a href="listreceivedbyaccount.html">listreceivedbyaccount</a>
<br>
<a href="listreceivedbyaddress.html">listreceivedbyaddress</a>
<br>
<a href="listsinceblock.html">listsinceblock</a>
<br>
<a href="listtransactions.html">listtransactions</a>
<br>
<a href="listunspent.html">listunspent</a>
<br>
<a href="lockunspent.html">lockunspent</a>
<br>
<a href="move.html">move</a>
<br>
<a href="opreturn_burn.html">opreturn_burn</a>
<br>
<a href="rescan.html">rescan</a>
<br>
<a href="resendwallettransactions.html">resendwallettransactions</a>
<br>
<a href="sendfrom.html">sendfrom</a>
<br>
<a href="sendmany.html">sendmany</a>
<br>
<a href="sendtoaddress.html">sendtoaddress</a>
<br>
<a href="setaccount.html">setaccount</a>
<br>
<a href="setpubkey.html">setpubkey</a>
<br>
<a href="settxfee.html">settxfee</a>
<br>
<a href="signmessage.html">signmessage</a>
<br>
<a href="z_anonsetblockdelta.html">z_anonsetblockdelta</a>
<br>
<a href="z_anonsettxdelta.html">z_anonsettxdelta</a>
<br>
<a href="z_consolidationstatus.html">z_consolidationstatus</a>
<br>
<a href="z_exportkey.html">z_exportkey</a>
<br>
<a href="z_exportviewingkey.html">z_exportviewingkey</a>
<br>
<a href="z_exportwallet.html">z_exportwallet</a>
<br>
<a href="z_getbalance.html">z_getbalance</a>
<br>
<a href="z_getbalances.html">z_getbalances</a>
<br>
<a href="z_getinfo.html">z_getinfo</a>
<br>
<a href="z_getnewaddress.html">z_getnewaddress</a>
<br>
<a href="z_getnotescount.html">z_getnotescount</a>
<br>
<a href="z_getoperationresult.html">z_getoperationresult</a>
<br>
<a href="z_getoperationstatus.html">z_getoperationstatus</a>
<br>
<a href="z_getstats.html">z_getstats</a>
<br>
<a href="z_gettotalbalance.html">z_gettotalbalance</a>
<br>
<a href="z_importkey.html">z_importkey</a>
<br>
<a href="z_importviewingkey.html">z_importviewingkey</a>
<br>
<a href="z_importwallet.html">z_importwallet</a>
<br>
<a href="z_listaddresses.html">z_listaddresses</a>
<br>
<a href="z_listnullifiers.html">z_listnullifiers</a>
<br>
<a href="z_listoperationids.html">z_listoperationids</a>
<br>
<a href="z_listreceivedaddress.html">z_listreceivedaddress</a>
<br>
<a href="z_listreceivedbyaddress.html">z_listreceivedbyaddress</a>
<br>
<a href="z_listsentbyaddress.html">z_listsentbyaddress</a>
<br>
<a href="z_listunspent.html">z_listunspent</a>
<br>
<a href="z_mergetoaddress.html">z_mergetoaddress</a>
<br>
<a href="z_sendmany.html">z_sendmany</a>
<br>
<a href="z_shieldcoinbase.html">z_shieldcoinbase</a>
<br>
<a href="z_sweepstatus.html">z_sweepstatus</a>
<br>
<a href="z_viewtransaction.html">z_viewtransaction</a>
<br>
</div>
</div>
<br>
</div>
</div>
</main>
</body>
</html>