ListUnspent
danger
This RPC is deprecated and will be removed in a future version.
Deprecated, use walletrpc.ListUnspent instead.
ListUnspent returns a list of all utxos spendable by the wallet with a number of confirmations between the specified minimum and maximum.
Source: lightning.proto
gRPC
rpc ListUnspent (ListUnspentRequest) returns (ListUnspentResponse);
REST
HTTP Method | Path |
---|---|
GET | /v1/utxos |
Code Samples
- gRPC
- REST
- Shell
- Javascript
- Python
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 = {
min_confs: <int32>,
max_confs: <int32>,
account: <string>,
};
client.listUnspent(request, function(err, response) {
console.log(response);
});
// Console output:
// {
// "utxos": <Utxo>,
// }
import codecs, grpc, os
# Generate the following 2 modules by compiling the lightning.proto with the grpcio-tools.
# See https://github.com/lightningnetwork/lnd/blob/master/docs/grpc/python.md for instructions.
import lightning_pb2 as lnrpc, lightning_pb2_grpc as lightningstub
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 = lightningstub.LightningStub(channel)
request = lnrpc.ListUnspentRequest(
min_confs=<int32>,
max_confs=<int32>,
account=<string>,
)
response = stub.ListUnspent(request)
print(response)
# {
# "utxos": <Utxo>,
# }
- Javascript
- Python
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}/v1/utxos`,
// 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:
// {
// "utxos": <array>, // <Utxo>
// }
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}/v1/utxos'
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())
# {
# "utxos": <Utxo>,
# }
$ lncli listunspent --help
NAME:
lncli listunspent - List utxos available for spending.
USAGE:
lncli listunspent [command options] [min-confs [max-confs]] [--unconfirmed_only]
CATEGORY:
On-chain
DESCRIPTION:
For each spendable utxo currently in the wallet, with at least min_confs
confirmations, and at most max_confs confirmations, lists the txid,
index, amount, address, address type, scriptPubkey and number of
confirmations. Use --min_confs=0 to include unconfirmed coins. To list
all coins with at least min_confs confirmations, omit the second
argument or flag '--max_confs'. To list all confirmed and unconfirmed
coins, no arguments are required. To see only unconfirmed coins, use
'--unconfirmed_only' with '--min_confs' and '--max_confs' set to zero or
not present.
OPTIONS:
--min_confs value the minimum number of confirmations for a utxo (default: 0)
--max_confs value the maximum number of confirmations for a utxo (default: 0)
--unconfirmed_only when min_confs and max_confs are zero, setting false implicitly overrides max_confs to be MaxInt32, otherwise max_confs remains zero. An error is returned if the value is true and both min_confs and max_confs are non-zero. (default: false)
Messages
lnrpc.ListUnspentRequest
Source: lightning.proto
Field | gRPC Type | REST Type | REST Placement |
---|---|---|---|
min_confs | int32 | integer | query |
max_confs | int32 | integer | query |
account | string | string | query |
lnrpc.ListUnspentResponse
Source: lightning.proto
Field | gRPC Type | REST Type |
---|---|---|
utxos | Utxo[] | array |
Nested Messages
lnrpc.OutPoint
Field | gRPC Type | REST Type |
---|---|---|
txid_bytes | bytes | string |
txid_str | string | string |
output_index | uint32 | integer |
lnrpc.Utxo
Field | gRPC Type | REST Type |
---|---|---|
address_type | AddressType | string |
address | string | string |
amount_sat | int64 | string |
pk_script | string | string |
outpoint | OutPoint | object |
confirmations | int64 | string |
Enums
lnrpc.AddressType
Name | Number |
---|---|
WITNESS_PUBKEY_HASH | 0 |
NESTED_PUBKEY_HASH | 1 |
UNUSED_WITNESS_PUBKEY_HASH | 2 |
UNUSED_NESTED_PUBKEY_HASH | 3 |
TAPROOT_PUBKEY | 4 |
UNUSED_TAPROOT_PUBKEY | 5 |