listreceivedbyaddress

listreceivedbyaddress ( minconf include_empty include_watchonly "address_filter" include_immature_coinbase ) List balances by receiving address. Arguments: 1. minconf (numeric, optional, default=1) The minimum number of confirmations before payments are included. 2. include_empty (boolean, optional, default=false) Whether to include addresses that haven't received any payments. 3. include_watchonly (boolean, optional, default=true for watch-only wallets, otherwise false) Whether to include watch-only addresses (see 'importaddress') 4. address_filter (string, optional) If present and non-empty, only return information on this address. 5. include_immature_coinbase (boolean, optional, default=false) Include immature coinbase transactions. Result: [ (json array) { (json object) "involvesWatchonly" : true|false, (boolean, optional) Only returns true if imported addresses were involved in transaction "address" : "str", (string) The receiving address "amount" : n, (numeric) The total amount in BTC received by the address "confirmations" : n, (numeric) The number of confirmations of the most recent transaction included "label" : "str", (string) The label of the receiving address. The default label is "" "txids" : [ (json array) "hex", (string) The ids of transactions received with the address ... ] }, ... ] Examples: > bitcoin-cli listreceivedbyaddress > bitcoin-cli listreceivedbyaddress 6 true > bitcoin-cli listreceivedbyaddress 6 true true "" true > curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "listreceivedbyaddress", "params": [6, true, true]}' -H 'content-type: application/json' http://127.0.0.1:8332/ > curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "listreceivedbyaddress", "params": [6, true, true, "bc1q09vm5lfy0j5reeulh4x5752q25uqqvz34hufdl", true]}' -H 'content-type: application/json' http://127.0.0.1:8332/

Signature

listreceivedbyaddress(minconf?: number, include_empty?: boolean, include_watchonly?: boolean, address_filter?: string, include_immature_coinbase?: boolean) → any

Code samples

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

bitcoin-cli listreceivedbyaddress

bitcoin-cli listreceivedbyaddress 6 true

bitcoin-cli listreceivedbyaddress 6 true true "" true

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

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

Parameters

Name	Type	Req.	Description
minconf	`number`	—	The minimum number of confirmations before payments are included.
include_empty	`boolean`	—	Whether to include addresses that haven't received any payments.
include_watchonly	`boolean`	—	Whether to include watch-only addresses (see 'importaddress')
address_filter	`string`	—	If present and non-empty, only return information on this address.
include_immature_coinbase	`boolean`	—	Include immature coinbase transactions.

Result

Type: any

[ (json array) { (json object) "involvesWatchonly" : true|false, (boolean, optional) Only returns true if imported addresses were involved in transaction "address" : "str", (string) The receiving address "amount" : n, (numeric) The total amount in BTC received by the address "confirmations" : n, (numeric) The number of confirmations of the most recent transaction included "label" : "str", (string) The label of the receiving address. The default label is "" "txids" : [ (json array) "hex", (string) The ids of transactions received with the address ... ] }, ... ]

Source: services/core-node/bcore/src/wallet/rpc/transactions.cpp:256

C++ symbol: listreceivedbyaddress

Code samples

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

bitcoin-cli listreceivedbyaddress

bitcoin-cli listreceivedbyaddress 6 true

bitcoin-cli listreceivedbyaddress 6 true true "" true

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

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