ListAddresses

ListAddresses retrieves all the addresses along with their balance. An account name filter can be provided to filter through all of the wallet accounts and return the addresses of only those matching.

Source: walletrpc/walletkit.proto

gRPC

rpc ListAddresses (ListAddressesRequest) returns (ListAddressesResponse);

REST

HTTP Method	Path
GET	/v2/wallet/addresses

Code Samples

gRPC

Javascript

const fs = require('fs');
const grpc = require('@grpc/grpc-js');
const protoLoader = require('@grpc/proto-loader');

const GRPC_HOST = 'localhost:10009'
const MACAROON_PATH = 'LND_DIR/data/chain/bitcoin/regtest/admin.macaroon'
const TLS_PATH = 'LND_DIR/tls.cert'

const loaderOptions = {
  keepCase: true,
  longs: String,
  enums: String,
  defaults: true,
  oneofs: true,
};
const packageDefinition = protoLoader.loadSync(['lightning.proto', 'walletrpc/walletkit.proto'], loaderOptions);
const walletrpc = grpc.loadPackageDefinition(packageDefinition).walletrpc;
process.env.GRPC_SSL_CIPHER_SUITES = 'HIGH+ECDSA';
const tlsCert = fs.readFileSync(TLS_PATH);
const sslCreds = grpc.credentials.createSsl(tlsCert);
const macaroon = fs.readFileSync(MACAROON_PATH).toString('hex');
const macaroonCreds = grpc.credentials.createFromMetadataGenerator(function(args, callback) {
  let metadata = new grpc.Metadata();
  metadata.add('macaroon', macaroon);
  callback(null, metadata);
});
let creds = grpc.credentials.combineChannelCredentials(sslCreds, macaroonCreds);
let client = new walletrpc.WalletKit(GRPC_HOST, creds);
let request = {
  account_name: <string>,
  show_custom_accounts: <bool>,
};
client.listAddresses(request, function(err, response) {
  console.log(response);
});
// Console output:
//  {
//    "account_with_addresses": <AccountWithAddresses>,
//  }

Python

import codecs, grpc, os
# Generate the following 2 modules by compiling the walletrpc/walletkit.proto with the grpcio-tools.
# See https://github.com/lightningnetwork/lnd/blob/master/docs/grpc/python.md for instructions.
import walletkit_pb2 as walletrpc, walletkit_pb2_grpc as walletkitstub

GRPC_HOST = 'localhost:10009'
MACAROON_PATH = 'LND_DIR/data/chain/bitcoin/regtest/admin.macaroon'
TLS_PATH = 'LND_DIR/tls.cert'

# create macaroon credentials
macaroon = codecs.encode(open(MACAROON_PATH, 'rb').read(), 'hex')
def metadata_callback(context, callback):
  callback([('macaroon', macaroon)], None)
auth_creds = grpc.metadata_call_credentials(metadata_callback)
# create SSL credentials
os.environ['GRPC_SSL_CIPHER_SUITES'] = 'HIGH+ECDSA'
cert = open(TLS_PATH, 'rb').read()
ssl_creds = grpc.ssl_channel_credentials(cert)
# combine macaroon and SSL credentials
combined_creds = grpc.composite_channel_credentials(ssl_creds, auth_creds)
# make the request
channel = grpc.secure_channel(GRPC_HOST, combined_creds)
stub = walletkitstub.WalletKitStub(channel)
request = walletrpc.ListAddressesRequest(
  account_name=<string>,
  show_custom_accounts=<bool>,
)
response = stub.ListAddresses(request)
print(response)
# {
#    "account_with_addresses": <AccountWithAddresses>,
# }

REST

Javascript

const fs = require('fs');
const request = require('request');

const REST_HOST = 'localhost:8080'
const MACAROON_PATH = 'LND_DIR/data/chain/bitcoin/regtest/admin.macaroon'

let options = {
  url: `https://${REST_HOST}/v2/wallet/addresses`,
  // Work-around for self-signed certificates.
  rejectUnauthorized: false,
  json: true,
  headers: {
    'Grpc-Metadata-macaroon': fs.readFileSync(MACAROON_PATH).toString('hex'),
  },
}
request.get(options, function(error, response, body) {
  console.log(body);
});
// Console output:
//  {
//    "account_with_addresses": <array>, // <AccountWithAddresses> 
//  }

Python

import base64, codecs, json, requests

REST_HOST = 'localhost:8080'
MACAROON_PATH = 'LND_DIR/data/chain/bitcoin/regtest/admin.macaroon'
TLS_PATH = 'LND_DIR/tls.cert'

url = f'https://{REST_HOST}/v2/wallet/addresses'
macaroon = codecs.encode(open(MACAROON_PATH, 'rb').read(), 'hex')
headers = {'Grpc-Metadata-macaroon': macaroon}
r = requests.get(url, headers=headers, verify=TLS_PATH)
print(r.json())
# {
#    "account_with_addresses": <AccountWithAddresses>,
# }

Shell

$ lncli wallet addresses list --help

NAME:
   lncli wallet addresses list - Retrieve information of existing on-chain wallet addresses.

USAGE:
   lncli wallet addresses list [command options] [arguments...]

DESCRIPTION:
   
  Retrieves information of existing on-chain wallet addresses along with
  their type, internal/external and balance.
  

OPTIONS:
   --account_name value    (optional) only addresses matching this account are returned
   --show_custom_accounts  (optional) set this to true to show lnd's custom accounts
   

Messages

walletrpc.ListAddressesRequest

Source: walletrpc/walletkit.proto

Field	gRPC Type	REST Type	REST Placement
account_name An optional filter to only return addresses matching this account.	string	string	query
show_custom_accounts An optional flag to return LND's custom accounts (Purpose=1017) public key along with other addresses.	bool	boolean	query

walletrpc.ListAddressesResponse

Source: walletrpc/walletkit.proto

Field	gRPC Type	REST Type
account_with_addresses A list of all the accounts and their addresses.	AccountWithAddresses[]	array

Nested Messages

walletrpc.AccountWithAddresses

Field	gRPC Type	REST Type
name The name used to identify the account.	string	string
address_type The type of addresses the account supports.	AddressType	string
derivation_path The derivation path corresponding to the account public key. This will always be empty for the default imported account in which single public keys are imported into.	string	string
addresses List of address, its type internal/external & balance. Note that the order of addresses will be random and not according to the derivation index, since that information is not stored by the underlying wallet.	AddressProperty[]	array

walletrpc.AddressProperty

Field	gRPC Type	REST Type
address The address encoded using the appropriate format depending on the address type (base58, bech32, bech32m). Note that lnd's internal/custom keys for channels and other functionality are derived from the same scope. Since they aren't really used as addresses and will never have an on-chain balance, we'll show the public key instead (only if the show_custom_accounts flag is provided).	string	string
is_internal Denotes if the address is a change address.	bool	boolean
balance The balance of the address.	int64	string
derivation_path The full derivation path of the address. This will be empty for imported addresses.	string	string
public_key The public key of the address. This will be empty for imported addresses.	bytes	string

Enums

walletrpc.AddressType

Name	Number
UNKNOWN	0
WITNESS_PUBKEY_HASH	1
NESTED_WITNESS_PUBKEY_HASH	2
HYBRID_NESTED_WITNESS_PUBKEY_HASH	3
TAPROOT_PUBKEY	4