Changeset View
Changeset View
Standalone View
Standalone View
doc/0.21.12/rpc/wallet/getbalance.md
- This file was added.
--- | |||||
name: getbalance | |||||
version: 0.21.12 | |||||
group: wallet | |||||
permalink: doc/0.21.12/rpc/wallet/getbalance/ | |||||
--- | |||||
getbalance ( "dummy" minconf include_watchonly avoid_reuse ) | |||||
Returns the total available balance. | |||||
The available balance is what the wallet considers currently spendable, and is | |||||
thus affected by options which limit spendability such as -spendzeroconfchange. | |||||
Arguments: | |||||
1. dummy (string, optional) Remains for backward compatibility. Must be excluded or set to "*". | |||||
2. minconf (numeric, optional, default=0) Only include transactions confirmed at least this many times. | |||||
3. include_watchonly (boolean, optional, default=false) Also include balance in watch-only addresses (see 'importaddress') | |||||
4. avoid_reuse (boolean, optional, default=true) (only available if avoid_reuse wallet flag is set) Do not include balance in dirty outputs; addresses are considered dirty if they have previously been used in a transaction. | |||||
Result: | |||||
amount (numeric) The total amount in BCH received for this wallet. | |||||
Examples: | |||||
The total amount in the wallet with 1 or more confirmations | |||||
> bitcoin-cli getbalance | |||||
The total amount in the wallet at least 6 blocks confirmed | |||||
> bitcoin-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:8332/ | |||||