Main Menu
LND API Methods Overview
30 min
lightning network api methods info methods getinfo https //lightning engineering/api docs/api/lnd/lightning/get info/ retrieves general information about the node including identity pubkey, alias, network, and version getnetworkinfo https //lightning engineering/api docs/api/lnd/lightning/get network info/ provides network wide data like total number of nodes, channels, and network capacity channelbalance https //lightning engineering/api docs/api/lnd/lightning/channel balance/ returns the sum of funds held in all open channels, distinguishing between local and remote balances walletbalance https //lightning engineering/api docs/api/lnd/lightning/wallet balance/ shows wallet balance details including confirmed, unconfirmed, and locked funds invoice methods addinvoice https //lightning engineering/api docs/api/lnd/lightning/add invoice/ creates a new lightning invoice with specified amount, memo, and optional parameters cancelinvoice https //lightning engineering/api docs/api/lnd/invoices/cancel invoice/ cancels an unpaid invoice to prevent it from being paid lookupinvoicev2 https //lightning engineering/api docs/api/lnd/invoices/lookup invoice v2/ retrieves detailed information about a specific invoice by payment hash subscribesingleinvoice https //lightning engineering/api docs/api/lnd/invoices/subscribe single invoice/ creates a real time subscription for updates to a specific invoice subscribeinvoices https //lightning engineering/api docs/api/lnd/lightning/subscribe invoices/ establishes a streaming connection to receive updates for all invoices listinvoices https //lightning engineering/api docs/api/lnd/lightning/list invoices/ returns a paginated list of all invoices, supporting filtering by payment status payment methods decodepayreq https //lightning engineering/api docs/api/lnd/lightning/decode pay req/ parses and decodes a bolt11 payment request, showing destination, amount, and other encoded information deleteallpayments https //lightning engineering/api docs/api/lnd/lightning/delete all payments/ removes all payment records from the database, primarily used for testing or resetting state deletepayment https //lightning engineering/api docs/api/lnd/lightning/delete payment/ deletes a specific payment record from the database listpayments https //lightning engineering/api docs/api/lnd/lightning/list payments/ returns a paginated list of all outgoing payments with detailed status information trackpaymentv2 https //lightning engineering/api docs/api/lnd/router/track payment v2/ provides real time tracking of a specific payment attempt trackpayments https //lightning engineering/api docs/api/lnd/router/track payments/ establishes a subscription to track the status of all payments sendpaymentv2 https //lightning engineering/api docs/api/lnd/router/send payment v2/ sends a payment through the lightning network with advanced routing options advanced methods channel management channelacceptor https //lightning engineering/api docs/api/lnd/lightning/channel acceptor/ creates a bidirectional stream to accept or reject incoming channel open requests based on custom criteria closechannel https //lightning engineering/api docs/api/lnd/lightning/close channel/ initiates a cooperative or force close of an existing channel with a specified channel point closedchannels https //lightning engineering/api docs/api/lnd/lightning/closed channels/ returns a list of all channels that have been closed, with details about the close type and transaction getchaninfo https //lightning engineering/api docs/api/lnd/lightning/get chan info/ retrieves detailed information about a specific channel using its channel id listchannels https //lightning engineering/api docs/api/lnd/lightning/list channels/ returns a list of all open channels with detailed information about capacity, balances, and state openchannelsync https //lightning engineering/api docs/api/lnd/lightning/open channel sync/ opens a new channel to a peer synchronously, blocking until the funding transaction is confirmed openchannel https //lightning engineering/api docs/api/lnd/lightning/open channel/ opens a new channel to a peer asynchronously, returning a stream of updates as the channel progresses pendingchannels https //lightning engineering/api docs/api/lnd/lightning/pending channels/ lists all channels that are pending open, closing, or in other intermediate states subscribechannelevents https //lightning engineering/api docs/api/lnd/lightning/subscribe channel events/ establishes a subscription to receive updates about channel lifecycle events on chain methods estimatefee https //lightning engineering/api docs/api/lnd/lightning/estimate fee/ estimates the fee rate needed for a transaction to be confirmed within a target number of blocks gettransactions https //lightning engineering/api docs/api/lnd/lightning/get transactions/ retrieves a list of on chain transactions that affect the wallet newaddress https //lightning engineering/api docs/api/lnd/lightning/new address/ generates a new address for receiving on chain bitcoin payments listunspent https //lightning engineering/api docs/api/lnd/wallet kit/list unspent/ returns a list of all unspent transaction outputs (utxos) controlled by the wallet listaddresses https //lightning engineering/api docs/api/lnd/wallet kit/list addresses/ returns a list of all addresses that have been generated by the wallet sendcoins https //lightning engineering/api docs/api/lnd/lightning/send coins/ sends bitcoin to a specified address, creating and broadcasting an on chain transaction sendmany https //lightning engineering/api docs/api/lnd/lightning/send many/ creates and broadcasts a transaction that sends to multiple addresses in a single operation subscribetransactions https //lightning engineering/api docs/api/lnd/lightning/subscribe transactions/ establishes a subscription to receive notifications about new on chain transactions peer methods connectpeer https //lightning engineering/api docs/api/lnd/lightning/connect peer/ establishes a connection to a remote peer using their public key and network address disconnectpeer https //lightning engineering/api docs/api/lnd/lightning/disconnect peer/ disconnects from a connected peer, closing all channels if the force flag is set listpeers https //lightning engineering/api docs/api/lnd/lightning/list peers/ returns a list of all connected peers with details about their connection and channels subscribepeerevents https //lightning engineering/api docs/api/lnd/lightning/subscribe peer events/ creates a subscription to receive updates about peer connection and disconnection events routing methods buildroute https //lightning engineering/api docs/api/lnd/router/build route/ manually constructs a route through the lightning network for payment delivery estimateroutefee https //lightning engineering/api docs/api/lnd/router/estimate route fee/ estimates the fee required to send a specific amount of satoshis to a destination node sendtoroutev2 https //lightning engineering/api docs/api/lnd/router/send to route v2/ sends a payment using a pre defined route, bypassing the built in pathfinding queryroutes https //lightning engineering/api docs/api/lnd/lightning/query routes/ finds potential routes through the network for sending a payment to a destination describegraph https //lightning engineering/api docs/api/lnd/lightning/describe graph/ returns a complete view of the network graph as known by the node hodl invoices addhodlinvoice https //lightning engineering/api docs/api/lnd/invoices/add hold invoice/ creates a hold invoice (also known as hodl invoice) that allows accepting payment without immediately settling it settleinvoice https //lightning engineering/api docs/api/lnd/invoices/settle invoice/ settles a previously created hold invoice by revealing the preimage