core-lightning/doc/lightning-listchannels.7

.TH "LIGHTNING-LISTCHANNELS" "7" "" "" "lightning-listchannels"
.SH NAME
lightning-listchannels - Command to query active lightning channels in the entire network
.SH SYNOPSIS

\fBlistchannels\fR [\fIshort_channel_id\fR] [\fIsource\fR] [\fIdestination\fR]

.SH DESCRIPTION

The \fBlistchannels\fR RPC command returns data on channels that are known
to the node\. Because channels may be bidirectional, up to 2 objects will
be returned for each channel (one for each direction)\.


If \fIshort_channel_id\fR is a short channel id, then only known channels with a
matching \fIshort_channel_id\fR are returned\.  Otherwise, it must be null\.


If \fIsource\fR is a node id, then only channels leading from that node id
are returned\.


If \fIdestination\fR is a node id, then only channels leading to that node id
are returned\.


Only one of \fIshort_channgel_id\fR, \fIsource\fR or \fIdestination\fR can be supplied\.
If nothing is supplied, data on all lightning channels known to this
node, are returned\. These can be local channels or public channels
broadcast on the gossip network\.

.SH RETURN VALUE

On success, an object containing \fBchannels\fR is returned\.  It is an array of objects, where each object contains:

.RS
.IP \[bu]
\fBsource\fR (pubkey): the source node
.IP \[bu]
\fBdestination\fR (pubkey): the destination node
.IP \[bu]
\fBpublic\fR (boolean): true if this is announced (otherwise it must be our channel)
.IP \[bu]
\fBamount_msat\fR (msat): the total capacity of this channel (always a whole number of satoshis)
.IP \[bu]
\fBmessage_flags\fR (u8): as defined by BOLT #7
.IP \[bu]
\fBchannel_flags\fR (u8): as defined by BOLT #7
.IP \[bu]
\fBactive\fR (boolean): true unless source has disabled it, or it's a local channel and the peer is disconnected or it's still opening or closing
.IP \[bu]
\fBlast_update\fR (u32): UNIX timestamp on the last channel_update from \fIsource\fR
.IP \[bu]
\fBbase_fee_millisatoshi\fR (u32): Base fee changed by \fIsource\fR to use this channel
.IP \[bu]
\fBfee_per_millionth\fR (u32): Proportional fee changed by \fIsource\fR to use this channel, in parts-per-million
.IP \[bu]
\fBdelay\fR (u32): The number of blocks delay required by \fIsource\fR to use this channel
.IP \[bu]
\fBhtlc_minimum_msat\fR (msat): The smallest payment \fIsource\fR will allow via this channel
.IP \[bu]
\fBfeatures\fR (hex): BOLT #9 features bitmap for this channel
.IP \[bu]
\fBhtlc_maximum_msat\fR (msat, optional): The largest payment \fIsource\fR will allow via this channel

.RE

If one of \fIshort_channel_id\fR, \fIsource\fR or \fIdestination\fR is supplied and no
matching channels are found, a "channels" object with an empty list is returned\.


On error the returned object will contain \fBcode\fR and \fBmessage\fR properties,
with \fBcode\fR being one of the following:

.RS
.IP \[bu]
-32602: If the given parameters are wrong\.

.RE
.SH AUTHOR

Michael Hawkins \fI<michael.hawkins@protonmail.com\fR>\.

.SH SEE ALSO

\fBlightning-fundchannel\fR(7), \fBlightning-listnodes\fR(7)

.SH RESOURCES

Main web site: \fIhttps://github.com/ElementsProject/lightning\fR


Lightning RFC site

.RS
.IP \[bu]
BOLT #7:
\fIhttps://github.com/lightningnetwork/lightning-rfc/blob/master/07-routing-gossip.md\fR

.RE
\" SHA256STAMP:b53e67e29b3ac9efe5157e8656ea5af5b2e418559655cc6f39fa99875f52bdc0