Documentation exported from Bitcoin Core 0.20.0

listlabels (0.20.0 RPC)

blockchain

control

generating

mining

network

rawtransactions

util

wallet

zmq

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)
  "str",    (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/