getaddressesbylabel

getaddressesbylabel "label" Returns the list of addresses assigned the specified label. Arguments: 1. label (string, required) The label. Result: { (json object) json object with addresses as keys "address" : { (json object) json object with information about address "purpose" : "str" (string) Purpose of address ("send" for sending address, "receive" for receiving address) }, ... } Examples: > bitcoin-cli getaddressesbylabel "tabby" > curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "getaddressesbylabel", "params": ["tabby"]}' -H 'content-type: application/json' http://127.0.0.1:8332/

Signature

getaddressesbylabel(label: string) → any

Code samples

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

bitcoin-cli getaddressesbylabel "tabby"

curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "getaddressesbylabel", "params": ["tabby"]}' -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": "getaddressesbylabel",
        "params": ["\"<label>\""],
    },
    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: "getaddressesbylabel",
    params: ["\"<label>\""],
  }),
});
console.log(await res.json());

Parameters

Name	Type	Req.	Description
label	`string`	yes	The label.

Result

Type: any

{ (json object) json object with addresses as keys "address" : { (json object) json object with information about address "purpose" : "str" (string) Purpose of address ("send" for sending address, "receive" for receiving address) }, ... }

Source: services/core-node/bcore/src/wallet/rpc/addresses.cpp:532

C++ symbol: getaddressesbylabel

Code samples

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

bitcoin-cli getaddressesbylabel "tabby"

curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "getaddressesbylabel", "params": ["tabby"]}' -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": "getaddressesbylabel",
        "params": ["\"<label>\""],
    },
    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: "getaddressesbylabel",
    params: ["\"<label>\""],
  }),
});
console.log(await res.json());