Skip to content

getreceivedbylabel JSON-RPC command

getreceivedbylabel "label" ( minconf )

Returns the total amount received by addresses with <label> in transactions with at least [minconf] confirmations.

Arguments

1. "label" (string, required) The selected label, may be the default label using "". 2. minconf (numeric, optional, default=1) Only include transactions confirmed at least this many times.

Result

amount (numeric) The total amount in BCH received for this label.

Examples

``` Amount received by the default label with at least 1 confirmation

bitcoin-cli getreceivedbylabel ""

Amount received at the tabby label including unconfirmed amounts with zero confirmations

bitcoin-cli getreceivedbylabel "tabby" 0

The amount with at least 6 confirmations

bitcoin-cli getreceivedbylabel "tabby" 6

As a JSON-RPC call

curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getreceivedbylabel", "params": ["tabby", 6] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ ```

Bitcoin Cash Node Daemon version v29.0.1-71febb2

Documentation on docs.bitcoincashnode.org reflects the current master branch in Git, and may include API changes that are not yet present in the latest release.