Skip to main content

WalletBalance

WalletBalance returns total unspent outputs(confirmed and unconfirmed), all confirmed unspent outputs and all unconfirmed unspent outputs under control of the wallet.

Source: lightning.proto

gRPC

rpc WalletBalance (WalletBalanceRequest) returns (WalletBalanceResponse);

REST

HTTP MethodPath
GET /v1/balance/blockchain

Code Samples

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', loaderOptions);
const lnrpc = grpc.loadPackageDefinition(packageDefinition).lnrpc;
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 lnrpc.Lightning(GRPC_HOST, creds);
let request = {
account: <string>,
min_confs: <int32>,
};
client.walletBalance(request, function(err, response) {
console.log(response);
});
// Console output:
// {
// "total_balance": <int64>,
// "confirmed_balance": <int64>,
// "unconfirmed_balance": <int64>,
// "locked_balance": <int64>,
// "reserved_balance_anchor_chan": <int64>,
// "account_balance": <AccountBalanceEntry>,
// }

Messages

lnrpc.WalletBalanceRequest

Source: lightning.proto

FieldgRPC TypeREST TypeREST Placement
account
stringstringquery
min_confs
int32integerquery

lnrpc.WalletBalanceResponse

Source: lightning.proto

FieldgRPC TypeREST Type
total_balance
int64string
confirmed_balance
int64string
unconfirmed_balance
int64string
locked_balance
int64string
reserved_balance_anchor_chan
int64string
account_balance
AccountBalanceEntry[]object

Nested Messages

lnrpc.WalletAccountBalance

FieldgRPC TypeREST Type
confirmed_balance
int64string
unconfirmed_balance
int64string

lnrpc.WalletBalanceResponse.AccountBalanceEntry

FieldgRPC TypeREST Type
key
stringunknown
value
WalletAccountBalanceunknown