getreceivedbyaddress

getreceivedbyaddress "address" ( minconf include_immature_coinbase ) Returns the total amount received by the given address in transactions with at least minconf confirmations. Arguments: 1. address (string, required) The bitcoin address for transactions. 2. minconf (numeric, optional, default=1) Only include transactions confirmed at least this many times. 3. include_immature_coinbase (boolean, optional, default=false) Include immature coinbase transactions. Result: n (numeric) The total amount in BTC received at this address. Examples: The amount from transactions with at least 1 confirmation > bitcoin-cli getreceivedbyaddress "bc1q09vm5lfy0j5reeulh4x5752q25uqqvz34hufdl" The amount including unconfirmed transactions, zero confirmations > bitcoin-cli getreceivedbyaddress "bc1q09vm5lfy0j5reeulh4x5752q25uqqvz34hufdl" 0 The amount with at least 6 confirmations > bitcoin-cli getreceivedbyaddress "bc1q09vm5lfy0j5reeulh4x5752q25uqqvz34hufdl" 6 The amount with at least 6 confirmations including immature coinbase outputs > bitcoin-cli getreceivedbyaddress "bc1q09vm5lfy0j5reeulh4x5752q25uqqvz34hufdl" 6 true As a JSON-RPC call > curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "getreceivedbyaddress", "params": ["bc1q09vm5lfy0j5reeulh4x5752q25uqqvz34hufdl", 6]}' -H 'content-type: application/json' http://127.0.0.1:8332/

Signature

getreceivedbyaddress(address: string, minconf?: number, include_immature_coinbase?: boolean) → any

Code samples

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

bitcoin-cli getreceivedbyaddress "bc1q09vm5lfy0j5reeulh4x5752q25uqqvz34hufdl"

bitcoin-cli getreceivedbyaddress "bc1q09vm5lfy0j5reeulh4x5752q25uqqvz34hufdl" 0

bitcoin-cli getreceivedbyaddress "bc1q09vm5lfy0j5reeulh4x5752q25uqqvz34hufdl" 6

bitcoin-cli getreceivedbyaddress "bc1q09vm5lfy0j5reeulh4x5752q25uqqvz34hufdl" 6 true

curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "getreceivedbyaddress", "params": ["bc1q09vm5lfy0j5reeulh4x5752q25uqqvz34hufdl", 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": "getreceivedbyaddress",
        "params": ["\"<address>\"", 1, false],
    },
    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: "getreceivedbyaddress",
    params: ["\"<address>\"",1,false],
  }),
});
console.log(await res.json());

Parameters

Name	Type	Req.	Description
address	`string`	yes	The bitcoin address for transactions.
minconf	`number`	—	Only include transactions confirmed at least this many times.
include_immature_coinbase	`boolean`	—	Include immature coinbase transactions.

Result

Type: any

n (numeric) The total amount in BTC received at this address.

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

C++ symbol: getreceivedbyaddress

Code samples

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

bitcoin-cli getreceivedbyaddress "bc1q09vm5lfy0j5reeulh4x5752q25uqqvz34hufdl"

bitcoin-cli getreceivedbyaddress "bc1q09vm5lfy0j5reeulh4x5752q25uqqvz34hufdl" 0

bitcoin-cli getreceivedbyaddress "bc1q09vm5lfy0j5reeulh4x5752q25uqqvz34hufdl" 6

bitcoin-cli getreceivedbyaddress "bc1q09vm5lfy0j5reeulh4x5752q25uqqvz34hufdl" 6 true

curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "getreceivedbyaddress", "params": ["bc1q09vm5lfy0j5reeulh4x5752q25uqqvz34hufdl", 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": "getreceivedbyaddress",
        "params": ["\"<address>\"", 1, false],
    },
    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: "getreceivedbyaddress",
    params: ["\"<address>\"",1,false],
  }),
});
console.log(await res.json());