Skip to content

listlabels JSON-RPC command

listlabels ( "purpose" )

Returns the list of all labels, or labels that are assigned to addresses with a specific purpose.

Arguments

1. "purpose" (string, optional) Address purpose to list labels for ('send','receive'). An empty string is the same as not providing this argument.

Result

[ (json array of string) "label", (string) Label name ... ]

Examples

``` List all labels

bitcoin-cli listlabels

List labels that have receiving addresses

bitcoin-cli listlabels receive

List labels that have sending addresses

bitcoin-cli listlabels send

As a JSON-RPC call

curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listlabels", "params": [receive] }' -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.