How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Lightning Labs Lightning API

The Lightning API from Lightning Labs — 64 operation(s) for lightning.

Lightning Labs Lightning API is published by Lightning Labs on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Lightning. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 71 operations across 64 paths, and defines 188 schemas. It is described by OpenAPI 2.0, at version 1.0.0.

71 operations 64 paths 188 schemas 7 DELETE38 GET26 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
1.0.0
Resource Areas
1

Paths & Operations 71

Across 64 paths, the API surfaces 71 operations — 7 DELETE, 38 GET, 26 POST. Each is listed below with its method, path, parameters, and response codes.

Lightning 71
GET
/v1/aliases/list
lncli: listaliases ListAliases returns the set of all aliases that have ever existed with their confirmed SCID (if it exists) and/or the base SCID (in the case of zero conf).
Lightning_ListAliases → 200default
GET
/v1/balance/blockchain
lncli: walletbalance WalletBalance returns total unspent outputs(confirmed and unconfirmed), all confirmed unspent outputs and all unconfirmed unspent outputs under control of the wallet.
Lightning_WalletBalance 2 params → 200default
GET
/v1/balance/channels
lncli: channelbalance ChannelBalance returns a report on the total funds across all open channels, categorized in local/remote, pending local/remote and unsettled local/remote balances.
Lightning_ChannelBalance → 200default
GET
/v1/channels
lncli: listchannels ListChannels returns a description of all the open channels that this node is a participant in.
Lightning_ListChannels 6 params → 200default
POST
/v1/channels
OpenChannelSync is a synchronous version of the OpenChannel RPC call. This call is meant to be consumed by clients to the REST proxy. As with all other sync calls, all byte slices are intended to be…
Lightning_OpenChannelSync 1 param → 200default
DELETE
/v1/channels/abandon/{channel_point.funding_txid_str}/{channel_point.output_index}
lncli: abandonchannel AbandonChannel removes all channel state from the database except for a close summary. This method can be used to get rid of permanently unusable channels due to bugs fixed in n…
Lightning_AbandonChannel 5 params → 200default
POST
/v1/channels/acceptor
ChannelAcceptor dispatches a bi-directional streaming RPC in which OpenChannel requests are sent to the client and the client responds with a boolean that tells LND whether or not to accept the chann…
Lightning_ChannelAcceptor 1 param → 200default
GET
/v1/channels/backup
ExportAllChannelBackups returns static channel backups for all existing channels known to lnd. A set of regular singular static channel backups for each channel are returned. Additionally, a multi-ch…
Lightning_ExportAllChannelBackups → 200default
POST
/v1/channels/backup/restore
lncli: restorechanbackup RestoreChannelBackups accepts a set of singular channel backups, or a single encrypted multi-chan backup and attempts to recover any funds remaining within the channel. If we…
Lightning_RestoreChannelBackups 1 param → 200default
GET
/v1/channels/backup/subscribe
SubscribeChannelBackups allows a client to sub-subscribe to the most up to date information concerning the state of all channel backups. Each time a new channel is added, we return the new set of cha…
Lightning_SubscribeChannelBackups → 200default
POST
/v1/channels/backup/verify
lncli: verifychanbackup VerifyChanBackup allows a caller to verify the integrity of a channel backup snapshot. This method will accept either a packed Single or a packed Multi. Specifying both will r…
Lightning_VerifyChanBackup 1 param → 200default
GET
/v1/channels/backup/{chan_point.funding_txid_str}/{chan_point.output_index}
lncli: exportchanbackup ExportChannelBackup attempts to return an encrypted static channel backup for the target channel identified by it channel point. The backup is encrypted with a key generated f…
Lightning_ExportChannelBackup 3 params → 200default
POST
/v1/channels/batch
lncli: batchopenchannel BatchOpenChannel attempts to open multiple single-funded channels in a single transaction in an atomic way. This means either all channel open requests succeed at once or all…
Lightning_BatchOpenChannel 1 param → 200default
GET
/v1/channels/closed
lncli: closedchannels ClosedChannels returns a description of all the closed channels that this node was a participant in.
Lightning_ClosedChannels 6 params → 200default
GET
/v1/channels/pending
lncli: pendingchannels PendingChannels returns a list of all the channels that are currently considered "pending". A channel is pending if it has finished the funding workflow and is waiting for conf…
Lightning_PendingChannels 1 param → 200default
POST
/v1/channels/stream
lncli: openchannel OpenChannel attempts to open a singly funded channel specified in the request to a remote peer. Users are able to specify a target number of blocks that the funding transaction sho…
Lightning_OpenChannel 1 param → 200default
GET
/v1/channels/subscribe
SubscribeChannelEvents creates a uni-directional stream from the server to the client in which any updates relevant to the state of the channels are sent over. Events include new active channels, ina…
Lightning_SubscribeChannelEvents → 200default
POST
/v1/channels/transaction-stream
lncli: sendpayment Deprecated, use routerrpc.SendPaymentV2. SendPayment dispatches a bi-directional streaming RPC for sending payments through the Lightning Network. A single RPC invocation creates a…
Lightning_SendPayment 1 param → 200default
POST
/v1/channels/transactions
Deprecated, use routerrpc.SendPaymentV2. SendPaymentSync is the synchronous non-streaming version of SendPayment. This RPC is intended to be consumed by clients of the REST proxy. Additionally, this…
Lightning_SendPaymentSync 1 param → 200default
POST
/v1/channels/transactions/route
Deprecated, use routerrpc.SendToRouteV2. SendToRouteSync is a synchronous version of SendToRoute. It Will block until the payment either fails or succeeds.
Lightning_SendToRouteSync 1 param → 200default
DELETE
/v1/channels/{channel_point.funding_txid_str}/{channel_point.output_index}
lncli: closechannel CloseChannel attempts to close an active channel identified by its channel outpoint (ChannelPoint). The actions of this method can additionally be augmented to attempt a force clo…
Lightning_CloseChannel 10 params → 200default
POST
/v1/chanpolicy
lncli: updatechanpolicy UpdateChannelPolicy allows the caller to update the fee schedule and channel policies for all channels globally, or a particular channel.
Lightning_UpdateChannelPolicy 1 param → 200default
POST
/v1/custommessage
lncli: sendcustom SendCustomMessage sends a custom peer message.
Lightning_SendCustomMessage 1 param → 200default
GET
/v1/custommessage/subscribe
lncli: subscribecustom SubscribeCustomMessages subscribes to a stream of incoming custom peer messages.
Lightning_SubscribeCustomMessages → 200default
POST
/v1/debuglevel
lncli: debuglevel DebugLevel allows a caller to programmatically set the logging verbosity of lnd. The logging can be targeted according to a coarse daemon-wide logging level, or in a granular fashio…
Lightning_DebugLevel 1 param → 200default
GET
/v1/fees
lncli: feereport FeeReport allows the caller to obtain a report detailing the current fee schedule enforced by the node globally for each channel.
Lightning_FeeReport → 200default
POST
/v1/funding/step
FundingStateStep is an advanced funding related call that allows the caller to either execute some preparatory steps for a funding workflow, or manually progress a funding workflow. The primary way a…
Lightning_FundingStateStep 1 param → 200default
GET
/v1/getdebuginfo
lncli: 'getdebuginfo' GetDebugInfo returns debug information concerning the state of the daemon and its subsystems. This includes the full configuration and the latest log entries from the log file.
Lightning_GetDebugInfo 1 param → 200default
GET
/v1/getinfo
lncli: getinfo GetInfo returns general information concerning the lightning node including it's identity pubkey, alias, the chains it is connected to, and information concerning the number of open+pe…
Lightning_GetInfo → 200default
GET
/v1/getrecoveryinfo
lncli: getrecoveryinfo GetRecoveryInfo returns information concerning the recovery mode including whether it's in a recovery mode, whether the recovery is finished, and the progress made so far.
Lightning_GetRecoveryInfo → 200default
GET
/v1/graph
lncli: describegraph DescribeGraph returns a description of the latest graph state from the point of view of the node. The graph information is partitioned into two components: all the nodes/vertexes…
Lightning_DescribeGraph 2 params → 200default
GET
/v1/graph/edge/{chan_id}
lncli: getchaninfo GetChanInfo returns the latest authenticated network announcement for the given channel identified by its channel ID: an 8-byte integer which uniquely identifies the location of tr…
Lightning_GetChanInfo 3 params → 200default
GET
/v1/graph/info
lncli: getnetworkinfo GetNetworkInfo returns some basic stats about the known channel graph from the point of view of the node.
Lightning_GetNetworkInfo → 200default
GET
/v1/graph/node/{pub_key}
lncli: getnodeinfo GetNodeInfo returns the latest advertised, aggregated, and authenticated channel information for the specified node identified by its public key.
Lightning_GetNodeInfo 3 params → 200default
GET
/v1/graph/nodemetrics
lncli: getnodemetrics GetNodeMetrics returns node metrics calculated from the graph. Currently the only supported metric is betweenness centrality of individual nodes.
Lightning_GetNodeMetrics 1 param → 200default
GET
/v1/graph/routes/{pub_key}/{amt}
lncli: queryroutes QueryRoutes attempts to query the daemon's Channel Router for a possible route to a target destination capable of carrying a specific amount of satoshis. The returned route contain…
Lightning_QueryRoutes 17 params → 200default
POST
/v1/graph/routes/{pub_key}/{amt}
lncli: queryroutes QueryRoutes attempts to query the daemon's Channel Router for a possible route to a target destination capable of carrying a specific amount of satoshis. The returned route contain…
Lightning_QueryRoutes2 3 params → 200default
GET
/v1/graph/subscribe
SubscribeChannelGraph launches a streaming RPC that allows the caller to receive notifications upon any changes to the channel graph topology from the point of view of the responding node. Events not…
Lightning_SubscribeChannelGraph → 200default
GET
/v1/htlc-resolution/{chan_id}/{htlc_index}
LookupHtlcResolution retrieves a final htlc resolution from the database. If the htlc has no final resolution yet, a NotFound grpc status code is returned.
Lightning_LookupHtlcResolution 2 params → 200default
GET
/v1/invoice/{r_hash_str}
lncli: lookupinvoice LookupInvoice attempts to look up an invoice according to its payment hash. The passed payment hash must be exactly 32 bytes, if not, an error is returned.
Lightning_LookupInvoice 2 params → 200default
GET
/v1/invoices
lncli: listinvoices ListInvoices returns a list of all the invoices currently stored within the database. Any active debug invoices are ignored. It has full support for paginated responses, allowing…
Lightning_ListInvoices 6 params → 200default
DELETE
/v1/invoices
lncli: deletecanceledinvoice DeleteCanceledInvoice removes a canceled invoice from the database. If the invoice is not in the canceled state, an error will be returned.
Lightning_DeleteCanceledInvoice 1 param → 200default
POST
/v1/invoices
lncli: addinvoice AddInvoice attempts to add a new invoice to the invoice database. Any duplicated invoices are rejected, therefore all invoices must have a unique payment preimage.
Lightning_AddInvoice 1 param → 200default
GET
/v1/invoices/subscribe
SubscribeInvoices returns a uni-directional stream (server - client) for notifying the client of newly added/settled invoices. The caller can optionally specify the addindex and/or the settleindex. I…
Lightning_SubscribeInvoices 2 params → 200default
POST
/v1/macaroon
lncli: bakemacaroon BakeMacaroon allows the creation of a new macaroon with custom read and write permissions. No first-party caveats are added since this can be done offline.
Lightning_BakeMacaroon 1 param → 200default
POST
/v1/macaroon/checkpermissions
CheckMacaroonPermissions checks whether the provided macaroon contains all the provided permissions. If the macaroon is valid (e.g. all caveats are satisfied), and all permissions provided in the req…
Lightning_CheckMacaroonPermissions 1 param → 200default
GET
/v1/macaroon/ids
lncli: listmacaroonids ListMacaroonIDs returns all root key IDs that are in use.
Lightning_ListMacaroonIDs → 200default
GET
/v1/macaroon/permissions
lncli: listpermissions ListPermissions lists all RPC method URIs and their required macaroon permissions to access them.
Lightning_ListPermissions → 200default
DELETE
/v1/macaroon/{root_key_id}
lncli: deletemacaroonid DeleteMacaroonID deletes the specified macaroon ID and invalidates all macaroons derived from that ID.
Lightning_DeleteMacaroonID 1 param → 200default
POST
/v1/middleware
RegisterRPCMiddleware adds a new gRPC middleware to the interceptor chain. A gRPC middleware is software component external to lnd that aims to add additional business logic to lnd by observing/inter…
Lightning_RegisterRPCMiddleware 7 params → 200default
GET
/v1/newaddress
lncli: newaddress NewAddress creates a new address under control of the local wallet.
Lightning_NewAddress 2 params → 200default
POST
/v1/onionmessage
lncli: sendonion SendOnionMessage sends an onion message to a peer.
Lightning_SendOnionMessage 1 param → 200default
GET
/v1/onionmessage/subscribe
lncli: subscribeonion SubscribeOnionMessages subscribes to a stream of incoming onion messages.
Lightning_SubscribeOnionMessages → 200default
DELETE
/v1/payment
lncli: deletepayments DeletePayment deletes an outgoing payment from DB. Note that it will not attempt to delete an In-Flight payment, since that would be unsafe.
Lightning_DeletePayment 2 params → 200default
GET
/v1/payments
lncli: listpayments ListPayments returns a list of all outgoing payments.
Lightning_ListPayments 8 params → 200default
DELETE
/v1/payments
lncli: deletepayments --all DeleteAllPayments deletes all outgoing payments from DB. Note that it will not attempt to delete In-Flight payments, since that would be unsafe.
Lightning_DeleteAllPayments 3 params → 200default
GET
/v1/payreq/{pay_req}
lncli: decodepayreq DecodePayReq takes an encoded payment request string and attempts to decode it, returning a full description of the conditions encoded within the payment request.
Lightning_DecodePayReq 1 param → 200default
GET
/v1/peers
lncli: listpeers ListPeers returns a verbose listing of all currently active peers.
Lightning_ListPeers 1 param → 200default
POST
/v1/peers
lncli: connect ConnectPeer attempts to establish a connection to a remote peer. This is at the networking level, and is used for communication between nodes. This is distinct from establishing a chan…
Lightning_ConnectPeer 1 param → 200default
GET
/v1/peers/subscribe
SubscribePeerEvents creates a uni-directional stream from the server to the client in which any events relevant to the state of peers are sent over. Events include peers going online and offline.
Lightning_SubscribePeerEvents → 200default
DELETE
/v1/peers/{pub_key}
lncli: disconnect DisconnectPeer attempts to disconnect one peer from another identified by a given pubKey. In the case that we currently have a pending or active channel with the target peer, then t…
Lightning_DisconnectPeer 1 param → 200default
POST
/v1/signmessage
lncli: signmessage SignMessage signs a message with this node's private key. The returned signature string is zbase32 encoded and pubkey recoverable, meaning that only the message digest and signatur…
Lightning_SignMessage 1 param → 200default
POST
/v1/stop
lncli: stop StopDaemon will send a shutdown request to the interrupt handler, triggering a graceful shutdown of the daemon.
Lightning_StopDaemon 1 param → 200default
POST
/v1/switch
lncli: fwdinghistory ForwardingHistory allows the caller to query the htlcswitch for a record of all HTLCs forwarded within the target time range, and integer offset within that time range, for a max…
Lightning_ForwardingHistory 1 param → 200default
GET
/v1/transactions
lncli: listchaintxns GetTransactions returns a list describing all the known transactions relevant to the wallet.
Lightning_GetTransactions 5 params → 200default
POST
/v1/transactions
lncli: sendcoins SendCoins executes a request to send coins to a particular address. Unlike SendMany, this RPC call only allows creating a single output at a time. If neither targetconf, or satpervby…
Lightning_SendCoins 1 param → 200default
GET
/v1/transactions/fee
lncli: estimatefee EstimateFee asks the chain backend to estimate the fee rate and total fees for a transaction that pays to multiple specified outputs.
Lightning_EstimateFee 5 params → 200default
POST
/v1/transactions/many
lncli: sendmany SendMany handles a request for a transaction that creates multiple specified outputs in parallel. If neither targetconf, or satpervbyte are set, then the internal wallet will consult…
Lightning_SendMany 1 param → 200default
GET
/v1/transactions/subscribe
SubscribeTransactions creates a uni-directional stream from the server to the client in which any newly discovered transactions relevant to the wallet are sent over.
Lightning_SubscribeTransactions 5 params → 200default
GET
/v1/utxos
lncli: listunspent Deprecated, use walletrpc.ListUnspent instead.
Lightning_ListUnspent 3 params → 200default
POST
/v1/verifymessage
lncli: verifymessage VerifyMessage verifies a signature over a message and recovers the signer's public key. The signature is only deemed valid if the recovered public key corresponds to a node key i…
Lightning_VerifyMessage 1 param → 200default

Schemas 188

The contract defines 188 schemas that model the data the API accepts and returns. The most detailed are lnrpcChannel (37 properties), lnrpcInvoice (29 properties), lnrpcOpenChannelRequest (28 properties), lnrpcGetInfoResponse (22 properties). Each schema is shown below with its type and property counts.

lnrpcClosedChannelUpdate
object
4 properties
lnrpcChannelGraph
object
Returns a new instance of the directed channel graph.
2 properties
lnrpcVerifyMessageRequest
object
2 properties
lnrpcPreviousOutPoint
object
2 properties
lnrpcFundingTransitionMsg
object
4 properties
lnrpcBakeMacaroonRequest
object
3 properties
lnrpcOutPoint
object
3 properties
lnrpcRPCMiddlewareRequest
object
9 properties
lnrpcPsbtShim
object
3 properties
lnrpcPaymentFailureReason
string
- FAILUREREASONNONE: Payment isn't failed (yet). - FAILUREREASONTIMEOUT: There are more routes to try, but the payment timeout was exceeded. - FAILUREREASONNOR…
lnrpcChannelBackups
object
1 property
lnrpcCloseOutput
object
4 properties
lnrpcNewAddressResponse
object
1 property
lnrpcBlindedHop
object
2 properties
lnrpcFeatureBit
string
lnrpcOutputDetail
object
6 properties
lnrpcHTLC
object
8 properties
lnrpcKeyLocator
object
2 properties
lnrpcEstimateFeeResponse
object
4 properties
lnrpcCheckMacPermResponse
object
1 property
lnrpcCustomMessage
object
3 properties
lnrpcUtxo
object
6 properties
lnrpcTransactionDetails
object
3 properties
lnrpcRPCMessage
object
5 properties
lnrpcChannelCloseSummary
object
16 properties
lnrpcOutputScriptType
string
lnrpcUpdateFailure
string
lnrpcChannel
object
37 properties
lnrpcOpenStatusUpdate
object
4 properties
lnrpcInitiator
string
PendingChannelsResponseForceClosedChannel
object
8 properties
lnrpcSendResponse
object
4 properties
lnrpcFundingShimCancel
object
1 property
lnrpcListUnspentResponse
object
1 property
lnrpcVerifyChanBackupResponse
object
1 property
lnrpcVerifyMessageResponse
object
2 properties
lnrpcChannelCommitUpdate
object
1 property
PendingChannelsResponsePendingOpenChannel
object
7 properties
lnrpcSendRequest
object
16 properties
lnrpcMacaroonPermission
object
2 properties
lnrpcForwardingHistoryRequest
object
7 properties
lnrpcNodeMetricsResponse
object
1 property
lnrpcBatchOpenChannel
object
20 properties
lnrpcMetadataValues
object
1 property
lnrpcClosedChannelsResponse
object
1 property
lnrpcAddressType
string
- p2wkh: Pay to witness key hash (WITNESSPUBKEYHASH = 0) - np2wkh: Pay to nested witness key hash (NESTEDPUBKEYHASH = 1) - p2tr: Pay to taproot pubkey (TAPROOT…
lnrpcListPeersResponse
object
1 property
lnrpcMPPRecord
object
2 properties
lnrpcBlindedPath
object
3 properties
lnrpcRestoreChanBackupRequest
object
2 properties
lnrpcSendOnionMessageResponse
object
1 property
lnrpcConnectPeerResponse
object
1 property
lnrpcPendingHTLC
object
6 properties
lnrpcFundingStateStepResp
object
lnrpcBatchOpenChannelRequest
object
7 properties
lnrpcChannelAcceptRequest
object
16 properties
lnrpcAddInvoiceResponse
object
4 properties
lnrpcSendCoinsResponse
object
1 property
lnrpcSendToRouteRequest
object
3 properties
lnrpcGetDebugInfoResponse
object
2 properties
lnrpcSendCoinsRequest
object
11 properties
lnrpcMultiChanBackup
object
2 properties
lnrpcSendOnionMessageRequest
object
3 properties
lnrpcNodeAddress
object
2 properties
lnrpcListChannelsResponse
object
1 property
lnrpcOpenChannelRequest
object
28 properties
lnrpcStreamAuth
object
1 property
lnrpcRouteHint
object
1 property
lnrpcCloseStatusUpdate
object
3 properties
lnrpcListAliasesResponse
object
1 property
HTLCAttemptHTLCStatus
string
lnrpcDebugLevelResponse
object
1 property
lnrpcConnectPeerRequest
object
3 properties
PeerEventEventType
string
lnrpcFailure
object
8 properties
lnrpcListPermissionsResponse
object
1 property
lnrpcDelCanceledInvoiceResp
object
1 property
lnrpcPeer
object
14 properties
lnrpcAmount
object
2 properties
lnrpcListPaymentsResponse
object
4 properties
lnrpcPolicyUpdateRequest
object
11 properties
lnrpcSendCustomMessageRequest
object
3 properties
PendingChannelsResponseCommitments
object
6 properties
ChannelEventUpdateUpdateType
string
lnrpcBatchOpenChannelResponse
object
1 property
PendingChannelsResponseClosedChannel
object
2 properties
lnrpcChannelAcceptResponse
object
11 properties
lnrpcStopRequest
object
lnrpcChannelEdgeUpdate
object
6 properties
lnrpcBlindedPathConfig
object
5 properties
lnrpcAMPRecord
object
3 properties
lnrpcSignMessageRequest
object
2 properties
lnrpcChain
object
2 properties
lnrpcPayment
object
16 properties
lnrpcEdgeLocator
object
2 properties
lnrpcListMacaroonIDsResponse
object
1 property
lnrpcRestoreBackupResponse
object
1 property
lnrpcFeeReportResponse
object
4 properties
lnrpcChannelUpdate
object
12 properties
lnrpcGetInfoResponse
object
22 properties
lnrpcAbandonChannelResponse
object
1 property
lnrpcDebugLevelRequest
object
2 properties
lnrpcSendManyResponse
object
1 property
lnrpcFeature
object
3 properties
lnrpcFundingShim
object
2 properties
lnrpcQueryRoutesResponse
object
2 properties
lnrpcOnionMessageUpdate
object
6 properties
lnrpcSignMessageResponse
object
1 property
lnrpcHopHint
object
5 properties
lnrpcChannelCloseUpdate
object
5 properties
protobufAny
object
1 property
lnrpcFeeLimit
object
3 properties
lnrpcLightningAddress
object
2 properties
lnrpcInvoiceHTLC
object
12 properties
lnrpcReadyForPsbtFunding
object
3 properties
lnrpcChannelEventUpdate
object
9 properties
lnrpcChannelBalanceResponse
object
9 properties
lnrpcListInvoiceResponse
object
3 properties
lnrpcGraphCacheStatus
string
lnrpcAliasMap
object
2 properties
lnrpcAMPInvoiceState
object
4 properties
lnrpcDeleteAllPaymentsResponse
object
1 property
lnrpcStopResponse
object
1 property
InvoiceInvoiceState
string
lnrpcMacaroonPermissionList
object
1 property
lnrpcKeyDescriptor
object
2 properties
FailureFailureCode
string
- RESERVED: The numbers assigned in this enumeration match the failure codes as defined in BOLT 4. Because protobuf 3 requires enums to start with 0, a RESERVE…
lnrpcBlindedPaymentPath
object
7 properties
lnrpcSendManyRequest
object
8 properties
lnrpcChannelEdge
object
A fully authenticated channel along with all its unique attributes. Once an authenticated channel announcement has been processed on the network, then an insta…
10 properties
lnrpcTransaction
object
12 properties
lnrpcInstantUpdate
object
1 property
lnrpcHTLCAttempt
object
7 properties
lnrpcHop
object
16 properties
lnrpcInvoice
object
29 properties
lnrpcGraphTopologyUpdate
object
3 properties
lnrpcNodeUpdate
object
7 properties
PaymentPaymentStatus
string
- UNKNOWN: Deprecated. This status will never be returned. - INFLIGHT: Payment has inflight HTLCs. - SUCCEEDED: Payment is settled. - FAILED: Payment is failed…
rpcStatus
object
3 properties
lnrpcWalletAccountBalance
object
2 properties
lnrpcChanPointShim
object
7 properties
lnrpcPayReq
object
14 properties
ChannelCloseSummaryClosureType
string
lnrpcChannelAuthProof
object
ChannelAuthProof is the authentication proof (the signature portion) for a channel. Using the four signatures contained in the struct, and some auxiliary knowl…
4 properties
lnrpcBakeMacaroonResponse
object
1 property
lnrpcChanBackupSnapshot
object
2 properties
lnrpcForwardingEvent
object
14 properties
lnrpcNodeInfo
object
4 properties
PendingChannelsResponsePendingChannel
object
14 properties
lnrpcForwardingHistoryResponse
object
2 properties
lnrpcInboundFee
object
2 properties
lnrpcInvoiceHTLCState
string
lnrpcFundingPsbtVerify
object
3 properties
lnrpcSendCustomMessageResponse
object
1 property
lnrpcGetRecoveryInfoResponse
object
3 properties
lnrpcWalletBalanceResponse
object
6 properties
lnrpcPendingUpdate
object
4 properties
lnrpcChannelBackup
object
2 properties
PendingChannelsResponseWaitingCloseChannel
object
7 properties
lnrpcRoute
object
A path through the channel graph which runs over one or more channels in succession. This struct carries all the information required to craft the Sphinx onion…
8 properties
lnrpcDisconnectPeerResponse
object
1 property
lnrpcChannelConstraints
object
6 properties
lnrpcFundingPsbtFinalize
object
3 properties
lnrpcResolutionType
string
- ANCHOR: We resolved an anchor output. - INCOMINGHTLC: We are resolving an incoming htlc on chain. This if this htlc is claimed, we swept the incoming htlc wi…
lnrpcNodePair
object
2 properties
lnrpcLightningNode
object
An individual vertex/node within the channel graph. A node is connected to other nodes by one or more channel edges emanating from it. As the graph is directed…
7 properties
lnrpcChannelOpenUpdate
object
1 property
lnrpcRoutingPolicy
object
10 properties
PeerSyncType
string
- UNKNOWNSYNC: Denotes that we cannot determine the peer's current sync type. - ACTIVESYNC: Denotes that we are actively receiving new graph updates from the p…
lnrpcChannelFeeReport
object
7 properties
ForceClosedChannelAnchorState
string
There are three resolution states for the anchor: limbo, lost and recovered. Derive the current state from the limbo and recovered balances. - LIMBO: The recov…
lnrpcPeerEvent
object
2 properties
lnrpcPolicyUpdateResponse
object
1 property
lnrpcPendingChannelsResponse
object
5 properties
lnrpcCommitmentType
string
- UNKNOWNCOMMITMENTTYPE: Returned when the commitment type isn't known or unavailable. - LEGACY: A channel using the legacy commitment format having tweaked to…
lnrpcFloatMetric
object
2 properties
lnrpcResolution
object
5 properties
lnrpcNetworkInfo
object
11 properties
lnrpcDeletePaymentResponse
object
1 property
lnrpcResolutionOutcome
string
- OUTCOMEUNKNOWN: Outcome unknown. - CLAIMED: An output was claimed on chain. - UNCLAIMED: An output was left unclaimed on chain. - ABANDONED: ResolverOutcomeA…
lnrpcCheckMacPermRequest
object
4 properties
lnrpcDeleteMacaroonIDResponse
object
1 property
lnrpcCoinSelectionStrategy
string
- STRATEGYUSEGLOBALCONFIG: Use the coin selection strategy defined in the global configuration (lnd.conf). - STRATEGYLARGEST: Select the largest available coin…
lnrpcLookupHtlcResolutionResponse
object
2 properties
lnrpcAMP
object
Details specific to AMP HTLCs.
5 properties
lnrpcFailedUpdate
object
3 properties
lnrpcTimestampedError
object
2 properties
lnrpcChannelPoint
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

lightning-labs-lightning-api-openapi.yml Raw ↑
Where this information came from

This is an independent, third-party profile of Lightning Labs Lightning API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.