ListAccounts

ListAccounts retrieves all accounts belonging to the wallet by default. A name and key scope filter can be provided to filter through all of the wallet accounts and return only those matching.

Source: walletrpc/walletkit.proto

gRPC

rpc ListAccounts (ListAccountsRequest) returns (ListAccountsResponse);

REST

HTTP Method	Path
GET	/v2/wallet/accounts

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 = {
  name: <string>,
  address_type: <AddressType>,
};
client.listAccounts(request, function(err, response) {
  console.log(response);
});
// Console output:
//  {
//    "accounts": <Account>,
//  }

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.ListAccountsRequest(
  name=<string>,
  address_type=<AddressType>,
)
response = stub.ListAccounts(request)
print(response)
# {
#    "accounts": <Account>,
# }

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/accounts`,
  // 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:
//  {
//    "accounts": <array>, // <Account> 
//  }

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/accounts'
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())
# {
#    "accounts": <Account>,
# }

Shell

$ lncli wallet accounts list --help

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

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

DESCRIPTION:
   
  Retrieves all accounts belonging to the wallet by default. A name and
  key scope filter can be provided to filter through all of the wallet
  accounts and return only those matching.
  

OPTIONS:
   --name value          (optional) only accounts matching this name are returned
   --address_type value  (optional) only accounts matching this address type are returned
   

Messages

walletrpc.ListAccountsRequest

Source: walletrpc/walletkit.proto

Field	gRPC Type	REST Type	REST Placement
name An optional filter to only return accounts matching this name.	string	string	query
address_type An optional filter to only return accounts matching this address type. Nested REST Parameters address_type: string in query	AddressType	object	query

walletrpc.ListAccountsResponse

Source: walletrpc/walletkit.proto

Field	gRPC Type	REST Type
accounts	Account[]	array

Nested Messages

walletrpc.Account

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
extended_public_key The public key backing the account that all keys are derived from represented as an extended key. This will always be empty for the default imported account in which single public keys are imported into.	string	string
master_key_fingerprint The fingerprint of the root key from which the account public key was derived from. This will always be zero for the default imported account in which single public keys are imported into. The bytes are in big-endian order.	bytes	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
external_key_count The number of keys derived from the external branch of the account public key. This will always be zero for the default imported account in which single public keys are imported into.	uint32	integer
internal_key_count The number of keys derived from the internal branch of the account public key. This will always be zero for the default imported account in which single public keys are imported into.	uint32	integer
watch_only Whether the wallet stores private keys for the account.	bool	boolean

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