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=true for watch-only wallets, otherwise 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: n (numeric) The total amount in BTC received for this wallet. Examples: The total amount in the wallet with 0 or more confirmations > bitcoin-cli getbalance The total amount in the wallet with at least 6 confirmations > bitcoin-cli getbalance "*" 6 As a JSON-RPC call > curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "getbalance", "params": ["*", 6]}' -H 'content-type: application/json' http://127.0.0.1:8332/

Signature

getbalance(dummy?: string, minconf?: number, include_watchonly?: boolean, avoid_reuse?: boolean) → any

Code samples

curl --user "$RPC_USER:$RPC_PASS" \
  --data-binary '{"jsonrpc":"1.0","id":"docs","method":"getbalance","params":["\"<dummy>\"",0,false,true]}' \
  -H 'content-type: text/plain;' \
  http://127.0.0.1:8332/

bitcoin-cli getbalance

bitcoin-cli getbalance "*" 6

curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "getbalance", "params": ["*", 6]}' -H 'content-type: application/json' http://127.0.0.1:8332/

import requests
r = requests.post(
    "http://127.0.0.1:8332/",
    auth=("$RPC_USER", "$RPC_PASS"),
    json={
        "jsonrpc": "1.0",
        "id": "docs",
        "method": "getbalance",
        "params": ["\"<dummy>\"", 0, false, true],
    },
    timeout=30,
)
print(r.json())

const res = await fetch("http://127.0.0.1:8332/", {
  method: "POST",
  headers: {
    "content-type": "application/json",
    "authorization": "Basic " + btoa(`${process.env.RPC_USER}:${process.env.RPC_PASS}`),
  },
  body: JSON.stringify({
    jsonrpc: "1.0",
    id: "docs",
    method: "getbalance",
    params: ["\"<dummy>\"",0,false,true],
  }),
});
console.log(await res.json());

Parameters

Name	Type	Req.	Description
dummy	`string`	—	Remains for backward compatibility. Must be excluded or set to "*".
minconf	`number`	—	Only include transactions confirmed at least this many times.
include_watchonly	`boolean`	—	Also include balance in watch-only addresses (see 'importaddress')
avoid_reuse	`boolean`	—	(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

Type: any

n (numeric) The total amount in BTC received for this wallet.

Source: services/core-node/bcore/src/wallet/rpc/coins.cpp:162

C++ symbol: getbalance

Code samples

curl --user "$RPC_USER:$RPC_PASS" \
  --data-binary '{"jsonrpc":"1.0","id":"docs","method":"getbalance","params":["\"<dummy>\"",0,false,true]}' \
  -H 'content-type: text/plain;' \
  http://127.0.0.1:8332/

bitcoin-cli getbalance

bitcoin-cli getbalance "*" 6

curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "getbalance", "params": ["*", 6]}' -H 'content-type: application/json' http://127.0.0.1:8332/

import requests
r = requests.post(
    "http://127.0.0.1:8332/",
    auth=("$RPC_USER", "$RPC_PASS"),
    json={
        "jsonrpc": "1.0",
        "id": "docs",
        "method": "getbalance",
        "params": ["\"<dummy>\"", 0, false, true],
    },
    timeout=30,
)
print(r.json())

const res = await fetch("http://127.0.0.1:8332/", {
  method: "POST",
  headers: {
    "content-type": "application/json",
    "authorization": "Basic " + btoa(`${process.env.RPC_USER}:${process.env.RPC_PASS}`),
  },
  body: JSON.stringify({
    jsonrpc: "1.0",
    id: "docs",
    method: "getbalance",
    params: ["\"<dummy>\"",0,false,true],
  }),
});
console.log(await res.json());