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.
The identity and technical contract details declared by the specification.
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
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
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
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
The full machine-readable OpenAPI contract behind this narrative.