listlabels

Back to wallet

Wallet

Summary

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

Description

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

Arguments

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

Results

  • value (ARR): No description.
  • label (STR): Label name

Examples

List all labels
qbit-cli listlabels
List labels that have receiving addresses
qbit-cli listlabels receive
List labels that have sending addresses
qbit-cli listlabels send
As a JSON-RPC call
curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "listlabels", "params": [receive]}' -H 'content-type: application/json' http://127.0.0.1:8352/