2018-03-08 17:34:40 -08:00
<!doctype html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=1200px, shrink-to-fit=yes" >
2021-10-14 16:57:50 -07:00
< meta name = "description" content = "Zcash 4.5.1-1 RPC Docs - z_gettotalbalance" >
2018-03-08 17:34:40 -08:00
< meta name = "author" content = "" >
2021-10-14 16:57:50 -07:00
< title > z_gettotalbalance - Zcash 4.5.1-1 RPC Docs< / title >
2018-03-08 17:34:40 -08:00
< 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 " >
2021-04-19 10:24:10 -07:00
< a class = "navbar-brand" href = "/" > Zcash 4.4.0 RPC docs< / a >
2018-03-08 17:34:40 -08:00
< / nav >
< main role = "main" class = "container-fluid" style = "margin-top: 1pc;" >
< div class = "row" >
2018-03-08 18:26:01 -08:00
< div class = "col-8 col-lg-9 col-xl-10" >
2021-10-14 16:57:50 -07:00
< h1 > z_gettotalbalance - Zcash 4.5.1-1 RPC< / h1 >
2018-03-09 04:16:57 -08:00
2018-06-10 07:43:39 -07:00
< pre > z_gettotalbalance ( minconf includeWatchonly )
2018-03-08 17:34:40 -08:00
2018-12-04 14:50:00 -08:00
Return the total value of funds stored in the node' s wallet.
2018-06-10 07:43:39 -07:00
2018-10-18 13:41:21 -07:00
CAUTION: If the wallet contains any addresses for which it only has incoming viewing keys,
the returned private balance may be larger than the actual balance, because spends cannot
be detected with incoming viewing keys.
2018-03-08 17:34:40 -08:00
Arguments:
2018-06-10 07:43:39 -07:00
1. minconf (numeric, optional, default=1) Only include private and transparent transactions confirmed at least this many times.
2. includeWatchonly (bool, optional, default=false) Also include balance in watchonly addresses (see ' importaddress' and ' z_importviewingkey' )
2018-03-08 17:34:40 -08:00
Result:
{
2018-06-10 07:43:39 -07:00
" transparent" : xxxxx, (numeric) the total balance of transparent funds
2019-08-27 13:43:20 -07:00
" private" : xxxxx, (numeric) the total balance of shielded funds (in both Sprout and Sapling addresses)
" total" : xxxxx, (numeric) the total balance of both transparent and shielded funds
2018-03-08 17:34:40 -08:00
}
Examples:
2018-06-10 07:43:39 -07:00
The total amount in the wallet
> zcash-cli z_gettotalbalance
The total amount in the wallet at least 5 blocks confirmed
> zcash-cli z_gettotalbalance 5
As a json rpc call
> curl --user myusername --data-binary ' {" jsonrpc" : " 1.0" , " id" :" curltest" , " method" : " z_gettotalbalance" , " params" : [5] }' -H ' content-type: text/plain;' http://127.0.0.1:8232/
2018-03-08 17:34:40 -08:00
2018-03-09 04:16:57 -08:00
< / pre >
< hr >
2018-03-08 17:34:40 -08:00
< p >
2021-10-14 16:57:50 -07:00
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 > )
2018-03-08 17:34:40 -08:00
< / p >
< p >
2021-10-14 16:57:50 -07:00
Note it uses a mainnet zcash node
2018-03-08 17:34:40 -08:00
< / p >
< / div >
2018-03-08 18:26:01 -08:00
< div class = "col-4 col-lg-3 col-xl-2" >
2018-03-09 04:16:57 -08:00
2019-08-27 13:43:20 -07:00
< 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 >
2018-03-09 04:16:57 -08:00
< 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 >
2019-08-27 13:43:20 -07:00
< a href = "getblockdeltas.html" > getblockdeltas< / a >
< br >
2018-03-09 04:16:57 -08:00
< a href = "getblockhash.html" > getblockhash< / a >
< br >
2019-08-27 13:43:20 -07:00
< a href = "getblockhashes.html" > getblockhashes< / a >
< br >
2018-03-09 04:16:57 -08:00
< 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 >
2019-08-27 13:43:20 -07:00
< a href = "getspentinfo.html" > getspentinfo< / a >
< br >
2018-03-09 04:16:57 -08:00
< 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 >
2020-12-23 07:47:21 -08:00
< a href = "z_gettreestate.html" > z_gettreestate< / a >
< br >
2018-03-09 04:16:57 -08:00
< / div >
< / div >
< br >
< div class = "card" >
< div class = "card-header" >
Control
< / div >
< div class = "card-body" >
2020-06-27 10:12:52 -07:00
< a href = "getexperimentalfeatures.html" > getexperimentalfeatures< / a >
< br >
2018-06-10 07:43:39 -07:00
< a href = "getinfo.html" > getinfo< / a >
2018-03-09 04:16:57 -08:00
< br >
2020-12-23 07:47:21 -08:00
< a href = "getmemoryinfo.html" > getmemoryinfo< / a >
< br >
2018-03-09 04:16:57 -08:00
< a href = "help.html" > help< / a >
< br >
2020-09-04 19:25:29 -07:00
< a href = "setlogfilter.html" > setlogfilter< / a >
< br >
2018-06-10 07:43:39 -07:00
< a href = "stop.html" > stop< / a >
2018-03-09 04:16:57 -08:00
< br >
2018-06-10 07:43:39 -07:00
< / div >
< / div >
< br >
< div class = "card" >
< div class = "card-header" >
Disclosure
< / div >
< div class = "card-body" >
< a href = "z_getpaymentdisclosure.html" > z_getpaymentdisclosure< / a >
2018-03-09 04:16:57 -08:00
< br >
2018-06-10 07:43:39 -07:00
< a href = "z_validatepaymentdisclosure.html" > z_validatepaymentdisclosure< / a >
2018-03-09 04:16:57 -08:00
< br >
< / div >
< / div >
< br >
2020-09-04 19:25:29 -07:00
< 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 >
2018-03-09 04:16:57 -08:00
< div class = "card" >
< div class = "card-header" >
Mining
< / div >
< div class = "card-body" >
2018-06-10 07:43:39 -07:00
< a href = "getblocksubsidy.html" > getblocksubsidy< / a >
< br >
2018-03-09 04:16:57 -08:00
< a href = "getblocktemplate.html" > getblocktemplate< / a >
< br >
2018-06-10 07:43:39 -07:00
< a href = "getlocalsolps.html" > getlocalsolps< / a >
< br >
2018-03-09 04:16:57 -08:00
< a href = "getmininginfo.html" > getmininginfo< / a >
< br >
< a href = "getnetworkhashps.html" > getnetworkhashps< / a >
< br >
2018-06-10 07:43:39 -07:00
< a href = "getnetworksolps.html" > getnetworksolps< / a >
< br >
2018-03-09 04:16:57 -08:00
< 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 >
2018-06-10 07:43:39 -07:00
< a href = "getdeprecationinfo.html" > getdeprecationinfo< / a >
< br >
2018-03-09 04:16:57 -08:00
< 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 >
2018-06-10 07:43:39 -07:00
< a href = "estimatepriority.html" > estimatepriority< / a >
2018-03-09 04:16:57 -08:00
< br >
< a href = "validateaddress.html" > validateaddress< / a >
< br >
< a href = "verifymessage.html" > verifymessage< / a >
< br >
2018-06-10 07:43:39 -07:00
< a href = "z_validateaddress.html" > z_validateaddress< / a >
< br >
2018-03-09 04:16:57 -08:00
< / 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 = "dumpwallet.html" > dumpwallet< / 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 >
2020-04-25 20:51:11 -07:00
< a href = "importpubkey.html" > importpubkey< / a >
< br >
2018-03-09 04:16:57 -08:00
< a href = "importwallet.html" > importwallet< / a >
< br >
< a href = "keypoolrefill.html" > keypoolrefill< / a >
< br >
2021-10-14 16:57:50 -07:00
< a href = "listaddresses.html" > listaddresses< / a >
2018-03-09 04:16:57 -08:00
< 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 >
2018-06-10 07:43:39 -07:00
< 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 >
2019-05-08 13:34:30 -07:00
< a href = "z_getmigrationstatus.html" > z_getmigrationstatus< / a >
< br >
2018-06-10 07:43:39 -07:00
< a href = "z_getnewaddress.html" > z_getnewaddress< / a >
< br >
2020-06-27 10:12:52 -07:00
< a href = "z_getnotescount.html" > z_getnotescount< / a >
< br >
2018-06-10 07:43:39 -07:00
< 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_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_listunspent.html" > z_listunspent< / a >
< br >
< a href = "z_mergetoaddress.html" > z_mergetoaddress< / a >
< br >
< a href = "z_sendmany.html" > z_sendmany< / a >
< br >
2019-05-08 13:34:30 -07:00
< a href = "z_setmigration.html" > z_setmigration< / a >
< br >
2018-06-10 07:43:39 -07:00
< a href = "z_shieldcoinbase.html" > z_shieldcoinbase< / a >
< br >
2020-06-27 10:12:52 -07:00
< a href = "z_viewtransaction.html" > z_viewtransaction< / a >
< br >
2018-06-10 07:43:39 -07:00
< a href = "zcbenchmark.html" > zcbenchmark< / a >
< br >
< a href = "zcrawjoinsplit.html" > zcrawjoinsplit< / a >
< br >
< a href = "zcrawkeygen.html" > zcrawkeygen< / a >
2018-03-09 04:16:57 -08:00
< br >
2018-06-10 07:43:39 -07:00
< a href = "zcrawreceive.html" > zcrawreceive< / a >
2018-03-09 04:16:57 -08:00
< br >
2018-06-10 07:43:39 -07:00
< a href = "zcsamplejoinsplit.html" > zcsamplejoinsplit< / a >
2018-03-09 04:16:57 -08:00
< br >
< / div >
< / div >
< br >
< / div >
2018-03-08 17:34:40 -08:00
< / div >
2018-03-09 04:16:57 -08:00
< / main >
2018-03-08 17:34:40 -08:00
< / body >
2018-03-09 04:16:57 -08:00
< / html >
