568 lines
19 KiB
HTML
568 lines
19 KiB
HTML
<!doctype html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=1200px, shrink-to-fit=yes">
|
|
<meta name="description" content="Zcash 5.5.0 RPC Docs - getbalance">
|
|
<meta name="author" content="">
|
|
<title>getbalance - Zcash 5.5.0 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="/">Zcash 5.5.0 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>getbalance - Zcash 5.5.0 RPC</h1>
|
|
|
|
<pre>getbalance ( "(dummy)" minconf includeWatchonly inZat asOfHeight )
|
|
|
|
Returns the wallet's available transparent balance. This total
|
|
currently includes transparent balances associated with unified
|
|
accounts. Prefer to use `z_getbalanceforaccount` instead.
|
|
|
|
Arguments:
|
|
1. (dummy) (string, optional) Remains for backward compatibility. Must be excluded or set to "*" or "".
|
|
2. minconf (numeric, optional, default=0) Only include transactions confirmed at least this many times.
|
|
3. includeWatchonly (bool, optional, default=false) Also include balance in watchonly addresses (see 'importaddress')
|
|
4. inZat (bool, optional, default=false) Get the result amount in zatoshis (as an integer).
|
|
5. asOfHeight (numeric, optional, default=-1) Execute the query as if it
|
|
were run when the blockchain was at the height specified by
|
|
this argument. The default is to use the entire blockchain
|
|
that the node is aware of. -1 can be used as in other RPC
|
|
calls to indicate the current height (including the
|
|
mempool), but this does not support negative values in
|
|
general. A “future” height will fall back to the current
|
|
height. Any explicit value will cause the mempool to be
|
|
ignored, meaning no unconfirmed tx will be considered.
|
|
`minconf` must be at least 1 when `asOfHeight` is provided.
|
|
|
|
Result:
|
|
amount (numeric) The total amount in ZEC(or zatoshis if inZat is true) received.
|
|
|
|
Bitcoin compatibility:
|
|
Compatible with up to three arguments.
|
|
Examples:
|
|
|
|
The total amount in the wallet
|
|
> zcash-cli getbalance *
|
|
|
|
The total amount in the wallet at least 5 blocks confirmed
|
|
> zcash-cli getbalance "*" 6
|
|
|
|
As a JSON RPC call
|
|
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getbalance", "params": ["*", 6] }' -H 'content-type: text/plain;' http://127.0.0.1:8232/
|
|
|
|
</pre>
|
|
<hr>
|
|
|
|
<p>
|
|
Maintained by <a href="https://twitter.com/_garethtdavies">@_garethtdavies</a>; modified by: <a href="https://github.com/mdr0id">mdr0id</a>;license of the docs is MIT (see <a href="https://github.com/zcash/zcash">zcash repo</a>), license of the scripts and webpage is also MIT (<a href="https://github.com/zcash-rpc/zcash-rpc.github.io">github repo</a>)
|
|
</p>
|
|
<p>
|
|
Note it uses a mainnet zcash node
|
|
</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="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>
|
|
|
|
</div>
|
|
</div>
|
|
<br>
|
|
|
|
<div class="card">
|
|
<div class="card-header">
|
|
Blockchain
|
|
</div>
|
|
<div class="card-body">
|
|
|
|
<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="getblockdeltas.html">getblockdeltas</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="getchaintips.html">getchaintips</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="verifychain.html">verifychain</a>
|
|
<br>
|
|
|
|
<a href="verifytxoutproof.html">verifytxoutproof</a>
|
|
<br>
|
|
|
|
<a href="z_gettreestate.html">z_gettreestate</a>
|
|
<br>
|
|
|
|
</div>
|
|
</div>
|
|
<br>
|
|
|
|
<div class="card">
|
|
<div class="card-header">
|
|
Control
|
|
</div>
|
|
<div class="card-body">
|
|
|
|
<a href="getexperimentalfeatures.html">getexperimentalfeatures</a>
|
|
<br>
|
|
|
|
<a href="getinfo.html">getinfo</a>
|
|
<br>
|
|
|
|
<a href="getmemoryinfo.html">getmemoryinfo</a>
|
|
<br>
|
|
|
|
<a href="help.html">help</a>
|
|
<br>
|
|
|
|
<a href="setlogfilter.html">setlogfilter</a>
|
|
<br>
|
|
|
|
<a href="stop.html">stop</a>
|
|
<br>
|
|
|
|
</div>
|
|
</div>
|
|
<br>
|
|
|
|
<div class="card">
|
|
<div class="card-header">
|
|
Disclosure
|
|
</div>
|
|
<div class="card-body">
|
|
|
|
<a href="z_getpaymentdisclosure.html">z_getpaymentdisclosure</a>
|
|
<br>
|
|
|
|
<a href="z_validatepaymentdisclosure.html">z_validatepaymentdisclosure</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="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">
|
|
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="getdeprecationinfo.html">getdeprecationinfo</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="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">
|
|
Util
|
|
</div>
|
|
<div class="card-body">
|
|
|
|
<a href="createmultisig.html">createmultisig</a>
|
|
<br>
|
|
|
|
<a href="estimatefee.html">estimatefee</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="addmultisigaddress.html">addmultisigaddress</a>
|
|
<br>
|
|
|
|
<a href="backupwallet.html">backupwallet</a>
|
|
<br>
|
|
|
|
<a href="dumpprivkey.html">dumpprivkey</a>
|
|
<br>
|
|
|
|
<a href="encryptwallet.html">encryptwallet</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="getreceivedbyaddress.html">getreceivedbyaddress</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="importpubkey.html">importpubkey</a>
|
|
<br>
|
|
|
|
<a href="importwallet.html">importwallet</a>
|
|
<br>
|
|
|
|
<a href="keypoolrefill.html">keypoolrefill</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="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="sendmany.html">sendmany</a>
|
|
<br>
|
|
|
|
<a href="sendtoaddress.html">sendtoaddress</a>
|
|
<br>
|
|
|
|
<a href="settxfee.html">settxfee</a>
|
|
<br>
|
|
|
|
<a href="signmessage.html">signmessage</a>
|
|
<br>
|
|
|
|
<a href="walletconfirmbackup.html">walletconfirmbackup</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_getaddressforaccount.html">z_getaddressforaccount</a>
|
|
<br>
|
|
|
|
<a href="z_getbalance.html">z_getbalance</a>
|
|
<br>
|
|
|
|
<a href="z_getbalanceforaccount.html">z_getbalanceforaccount</a>
|
|
<br>
|
|
|
|
<a href="z_getbalanceforviewingkey.html">z_getbalanceforviewingkey</a>
|
|
<br>
|
|
|
|
<a href="z_getmigrationstatus.html">z_getmigrationstatus</a>
|
|
<br>
|
|
|
|
<a href="z_getnewaccount.html">z_getnewaccount</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_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_listaccounts.html">z_listaccounts</a>
|
|
<br>
|
|
|
|
<a href="z_listaddresses.html">z_listaddresses</a>
|
|
<br>
|
|
|
|
<a href="z_listoperationids.html">z_listoperationids</a>
|
|
<br>
|
|
|
|
<a href="z_listreceivedbyaddress.html">z_listreceivedbyaddress</a>
|
|
<br>
|
|
|
|
<a href="z_listunifiedreceivers.html">z_listunifiedreceivers</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_setmigration.html">z_setmigration</a>
|
|
<br>
|
|
|
|
<a href="z_shieldcoinbase.html">z_shieldcoinbase</a>
|
|
<br>
|
|
|
|
<a href="z_viewtransaction.html">z_viewtransaction</a>
|
|
<br>
|
|
|
|
<a href="zcbenchmark.html">zcbenchmark</a>
|
|
<br>
|
|
|
|
<a href="zcsamplejoinsplit.html">zcsamplejoinsplit</a>
|
|
<br>
|
|
|
|
</div>
|
|
</div>
|
|
<br>
|
|
|
|
</div>
|
|
</div>
|
|
</main>
|
|
</body>
|
|
</html>
|