Channel
This is an object representing a channel on the Lightning Network. You can retrieve this object to get detailed information on a specific Lightning Network channel.Fields (20)id
The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque string.created_at
The date and time when the entity was first created.updated_at
The date and time when the entity was last updated.funding_transaction
The transaction that funded the channel upon channel opening.ChannelOpeningTransaction (optional)
capacity
The total amount of funds in this channel, including the channel balance on the local node, the channel balance on the remote node and the on-chain fees to close the channel.CurrencyAmount (optional)
local_balance
The channel balance on the local node.CurrencyAmount (optional)
local_unsettled_balance
The channel balance on the local node that is currently allocated to in-progress payments.CurrencyAmount (optional)
remote_balance
The channel balance on the remote node.CurrencyAmount (optional)
remote_unsettled_balance
The channel balance on the remote node that is currently allocated to in-progress payments.CurrencyAmount (optional)
unsettled_balance
The channel balance that is currently allocated to in-progress payments.CurrencyAmount (optional)
total_balance
The total balance in this channel, including the channel balance on both local and remote nodes.CurrencyAmount (optional)
uptime_percentage
An integer between 0 and 100 (included) that represents the percentage of uptime for this channel.Int (optional)
DEPRECATED: Not supported.
transactions
A connection to all transactions that have occurred on the channel including outgoing payments, incoming payments, routing transactions and on-chain transactions.DEPRECATED: Use account.transactions filtering with lightning_node_id instead.
status
The current status of this channel.ChannelStatus (optional)
estimated_force_closure_wait_minutes
The estimated time to wait for the channel's hash timelock contract to expire when force closing the channel. It is in unit of minutes.Int (optional)
commit_fee
The amount to be paid in fees for the current set of commitment transactions.CurrencyAmount (optional)
fees
The fees charged for routing payments through this channel.ChannelFees (optional)
DEPRECATED: Customer nodes do not route payments anymore.
remote_node
If known, the remote node of the channel.Node (optional)
local_node
The local Lightspark node of the channel.short_channel_id
The unique identifier of the channel on Lightning Network, which is the location in the chain that the channel was confirmed. The format is <block-height>:<tx-index>:<tx-output>.String (optional)
- Entity