Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Contact Us
Online Help
Domain Status
Man Pages

Virtual Servers

Topology Map

Server Agreement
Year 2038

USA Flag



Man Pages

lightning-listchannels - Command to query active lightning channels in the entire network

listchannels [short_channel_id] [source] [destination]

The listchannels 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 short_channel_id is a short channel id, then only known channels with a matching short_channel_id are returned. Otherwise, it must be null.

If source is a node id, then only channels leading from that node id are returned.

If destination is a node id, then only channels leading to that node id are returned.

Only one of short_channgel_id, source or destination 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.

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

source (pubkey): the source node
destination (pubkey): the destination node
public (boolean): true if this is announced (otherwise it must be our channel)
amount_msat (msat): the total capacity of this channel (always a whole number of satoshis)
message_flags (u8): as defined by BOLT #7
channel_flags (u8): as defined by BOLT #7
active (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
last_update (u32): UNIX timestamp on the last channel_update from source
base_fee_millisatoshi (u32): Base fee changed by source to use this channel
fee_per_millionth (u32): Proportional fee changed by source to use this channel, in parts-per-million
delay (u32): The number of blocks delay required by source to use this channel
htlc_minimum_msat (msat): The smallest payment source will allow via this channel
features (hex): BOLT #9 features bitmap for this channel
htlc_maximum_msat (msat, optional): The largest payment source will allow via this channel

If one of short_channel_id, source or destination is supplied and no matching channels are found, a "channels" object with an empty list is returned.

On error the returned object will contain code and message properties, with code being one of the following:

-32602: If the given parameters are wrong.

Michael Hawkins <>.

lightning-fundchannel(7), lightning-listnodes(7)

Main web site:

Lightning RFC site

BOLT #7:

Search for    or go to Top of page |  Section 7 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.