REST Endpoints
Here's a list of all the REST API endpoints available in LND.
| REST Path | REST Method | RPC |
|---|---|---|
| /v1/aliases/list | GET | lnrpc.ListAliases |
| /v1/balance/blockchain | GET | lnrpc.WalletBalance |
| /v1/balance/channels | GET | lnrpc.ChannelBalance |
| /v1/changepassword | POST | lnrpc.ChangePassword |
| /v1/channels | POST | lnrpc.OpenChannelSync |
| /v1/channels | GET | lnrpc.ListChannels |
| /v1/channels/abandon/{channel_point.funding_txid_str}/{channel_point.output_index} | DELETE | lnrpc.AbandonChannel |
| /v1/channels/acceptor | POST | lnrpc.ChannelAcceptor |
| /v1/channels/backup | GET | lnrpc.ExportAllChannelBackups |
| /v1/channels/backup/restore | POST | lnrpc.RestoreChannelBackups |
| /v1/channels/backup/subscribe | GET | lnrpc.SubscribeChannelBackups |
| /v1/channels/backup/verify | POST | lnrpc.VerifyChanBackup |
| /v1/channels/backup/{chan_point.funding_txid_str}/{chan_point.output_index} | GET | lnrpc.ExportChannelBackup |
| /v1/channels/batch | POST | lnrpc.BatchOpenChannel |
| /v1/channels/closed | GET | lnrpc.ClosedChannels |
| /v1/channels/pending | GET | lnrpc.PendingChannels |
| /v1/channels/stream | POST | lnrpc.OpenChannel |
| /v1/channels/subscribe | GET | lnrpc.SubscribeChannelEvents |
| /v1/channels/transaction-stream | POST | lnrpc.SendPayment |
| /v1/channels/transactions | POST | lnrpc.SendPaymentSync |
| /v1/channels/transactions/route | POST | lnrpc.SendToRouteSync |
| /v1/channels/{channel_point.funding_txid_str}/{channel_point.output_index} | DELETE | lnrpc.CloseChannel |
| /v1/chanpolicy | POST | lnrpc.UpdateChannelPolicy |
| /v1/custommessage | POST | lnrpc.SendCustomMessage |
| /v1/custommessage/subscribe | GET | lnrpc.SubscribeCustomMessages |
| /v1/debuglevel | POST | lnrpc.DebugLevel |
| /v1/fees | GET | lnrpc.FeeReport |
| /v1/funding/step | POST | lnrpc.FundingStateStep |
| /v1/genseed | GET | lnrpc.GenSeed |
| /v1/getdebuginfo | GET | lnrpc.GetDebugInfo |
| /v1/getinfo | GET | lnrpc.GetInfo |
| /v1/getrecoveryinfo | GET | lnrpc.GetRecoveryInfo |
| /v1/graph | GET | lnrpc.DescribeGraph |
| /v1/graph/edge/{chan_id} | GET | lnrpc.GetChanInfo |
| /v1/graph/info | GET | lnrpc.GetNetworkInfo |
| /v1/graph/node/{pub_key} | GET | lnrpc.GetNodeInfo |
| /v1/graph/nodemetrics | GET | lnrpc.GetNodeMetrics |
| /v1/graph/routes/{pub_key}/{amt} | GET | lnrpc.QueryRoutes |
| /v1/graph/subscribe | GET | lnrpc.SubscribeChannelGraph |
| /v1/htlc-resolution/{chan_id}/{htlc_index} | GET | lnrpc.LookupHtlcResolution |
| /v1/initwallet | POST | lnrpc.InitWallet |
| /v1/invoice/{r_hash_str} | GET | lnrpc.LookupInvoice |
| /v1/invoices | POST | lnrpc.AddInvoice |
| /v1/invoices | GET | lnrpc.ListInvoices |
| /v1/invoices/subscribe | GET | lnrpc.SubscribeInvoices |
| /v1/macaroon | POST | lnrpc.BakeMacaroon |
| /v1/macaroon/checkpermissions | POST | lnrpc.CheckMacaroonPermissions |
| /v1/macaroon/ids | GET | lnrpc.ListMacaroonIDs |
| /v1/macaroon/permissions | GET | lnrpc.ListPermissions |
| /v1/macaroon/{root_key_id} | DELETE | lnrpc.DeleteMacaroonID |
| /v1/middleware | POST | lnrpc.RegisterRPCMiddleware |
| /v1/newaddress | GET | lnrpc.NewAddress |
| /v1/payment | DELETE | lnrpc.DeletePayment |
| /v1/payments | GET | lnrpc.ListPayments |
| /v1/payments | DELETE | lnrpc.DeleteAllPayments |
| /v1/payreq/{pay_req} | GET | lnrpc.DecodePayReq |
| /v1/peers | POST | lnrpc.ConnectPeer |
| /v1/peers | GET | lnrpc.ListPeers |
| /v1/peers/subscribe | GET | lnrpc.SubscribePeerEvents |
| /v1/peers/{pub_key} | DELETE | lnrpc.DisconnectPeer |
| /v1/signmessage | POST | lnrpc.SignMessage |
| /v1/state | GET | lnrpc.GetState |
| /v1/state/subscribe | GET | lnrpc.SubscribeState |
| /v1/stop | POST | lnrpc.StopDaemon |
| /v1/switch | POST | lnrpc.ForwardingHistory |
| /v1/transactions | GET | lnrpc.GetTransactions |
| /v1/transactions | POST | lnrpc.SendCoins |
| /v1/transactions/fee | GET | lnrpc.EstimateFee |
| /v1/transactions/many | POST | lnrpc.SendMany |
| /v1/transactions/subscribe | GET | lnrpc.SubscribeTransactions |
| /v1/unlockwallet | POST | lnrpc.UnlockWallet |
| /v1/utxos | GET | lnrpc.ListUnspent |
| /v1/verifymessage | POST | lnrpc.VerifyMessage |
| /v2/autopilot/modify | POST | autopilotrpc.ModifyStatus |
| /v2/autopilot/scores | POST | autopilotrpc.SetScores |
| /v2/autopilot/scores | GET | autopilotrpc.QueryScores |
| /v2/autopilot/status | GET | autopilotrpc.Status |
| /v2/chainkit/bestblock | GET | chainrpc.GetBestBlock |
| /v2/chainkit/block | GET | chainrpc.GetBlock |
| /v2/chainkit/blockhash | GET | chainrpc.GetBlockHash |
| /v2/chainkit/blockheader | GET | chainrpc.GetBlockHeader |
| /v2/chainnotifier/register/blocks | POST | chainrpc.RegisterBlockEpochNtfn |
| /v2/chainnotifier/register/confirmations | POST | chainrpc.RegisterConfirmationsNtfn |
| /v2/chainnotifier/register/spends | POST | chainrpc.RegisterSpendNtfn |
| /v2/dev/importgraph | POST | devrpc.ImportGraph |
| /v2/dev/quiesce | POST | devrpc.Quiesce |
| /v2/invoices/cancel | POST | invoicesrpc.CancelInvoice |
| /v2/invoices/hodl | POST | invoicesrpc.AddHoldInvoice |
| /v2/invoices/htlcmodifier | POST | invoicesrpc.HtlcModifier |
| /v2/invoices/lookup | GET | invoicesrpc.LookupInvoiceV2 |
| /v2/invoices/settle | POST | invoicesrpc.SettleInvoice |
| /v2/invoices/subscribe/{r_hash} | GET | invoicesrpc.SubscribeSingleInvoice |
| /v2/neutrino/addpeer | POST | neutrinorpc.AddPeer |
| /v2/neutrino/block/{hash} | GET | neutrinorpc.GetBlock |
| /v2/neutrino/blockhash/{height} | GET | neutrinorpc.GetBlockHash |
| /v2/neutrino/blockheader/{hash} | GET | neutrinorpc.GetBlockHeader |
| /v2/neutrino/cfilter/{hash} | GET | neutrinorpc.GetCFilter |
| /v2/neutrino/disconnect | POST | neutrinorpc.DisconnectPeer |
| /v2/neutrino/isbanned | GET | neutrinorpc.IsBanned |
| /v2/neutrino/status | GET | neutrinorpc.Status |
| /v2/peers/nodeannouncement | POST | peersrpc.UpdateNodeAnnouncement |
| /v2/router/htlcevents | GET | routerrpc.SubscribeHtlcEvents |
| /v2/router/htlcinterceptor | POST | routerrpc.HtlcInterceptor |
| /v2/router/mc | GET | routerrpc.QueryMissionControl |
| /v2/router/mc/probability/{from_node}/{to_node}/{amt_msat} | GET | routerrpc.QueryProbability |
| /v2/router/mc/reset | POST | routerrpc.ResetMissionControl |
| /v2/router/mccfg | GET | routerrpc.GetMissionControlConfig |
| /v2/router/mccfg | POST | routerrpc.SetMissionControlConfig |
| /v2/router/payments | GET | routerrpc.TrackPayments |
| /v2/router/route | POST | routerrpc.BuildRoute |
| /v2/router/route/estimatefee | POST | routerrpc.EstimateRouteFee |
| /v2/router/route/send | POST | routerrpc.SendToRouteV2 |
| /v2/router/send | POST | routerrpc.SendPaymentV2 |
| /v2/router/track/{payment_hash} | GET | routerrpc.TrackPaymentV2 |
| /v2/router/updatechanstatus | POST | routerrpc.UpdateChanStatus |
| /v2/router/x/addaliases | POST | routerrpc.XAddLocalChanAliases |
| /v2/router/x/deletealiases | POST | routerrpc.XDeleteLocalChanAliases |
| /v2/router/x/importhistory | POST | routerrpc.XImportMissionControl |
| /v2/signer/inputscript | POST | signrpc.ComputeInputScript |
| /v2/signer/musig2/cleanup | POST | signrpc.MuSig2Cleanup |
| /v2/signer/musig2/combinekeys | POST | signrpc.MuSig2CombineKeys |
| /v2/signer/musig2/combinesig | POST | signrpc.MuSig2CombineSig |
| /v2/signer/musig2/createsession | POST | signrpc.MuSig2CreateSession |
| /v2/signer/musig2/registernonces | POST | signrpc.MuSig2RegisterNonces |
| /v2/signer/musig2/sign | POST | signrpc.MuSig2Sign |
| /v2/signer/sharedkey | POST | signrpc.DeriveSharedKey |
| /v2/signer/signmessage | POST | signrpc.SignMessage |
| /v2/signer/signraw | POST | signrpc.SignOutputRaw |
| /v2/signer/verifymessage | POST | signrpc.VerifyMessage |
| /v2/versioner/version | GET | verrpc.GetVersion |
| /v2/wallet/BumpForceCloseFee | POST | walletrpc.BumpForceCloseFee |
| /v2/wallet/accounts | GET | walletrpc.ListAccounts |
| /v2/wallet/accounts/import | POST | walletrpc.ImportAccount |
| /v2/wallet/address/next | POST | walletrpc.NextAddr |
| /v2/wallet/address/signmessage | POST | walletrpc.SignMessageWithAddr |
| /v2/wallet/address/verifymessage | POST | walletrpc.VerifyMessageWithAddr |
| /v2/wallet/addresses | GET | walletrpc.ListAddresses |
| /v2/wallet/bumpfee | POST | walletrpc.BumpFee |
| /v2/wallet/estimatefee/{conf_target} | GET | walletrpc.EstimateFee |
| /v2/wallet/key | POST | walletrpc.DeriveKey |
| /v2/wallet/key/import | POST | walletrpc.ImportPublicKey |
| /v2/wallet/key/next | POST | walletrpc.DeriveNextKey |
| /v2/wallet/psbt/finalize | POST | walletrpc.FinalizePsbt |
| /v2/wallet/psbt/fund | POST | walletrpc.FundPsbt |
| /v2/wallet/psbt/sign | POST | walletrpc.SignPsbt |
| /v2/wallet/removetx | POST | walletrpc.RemoveTransaction |
| /v2/wallet/reserve | GET | walletrpc.RequiredReserve |
| /v2/wallet/send | POST | walletrpc.SendOutputs |
| /v2/wallet/sweeps | GET | walletrpc.ListSweeps |
| /v2/wallet/sweeps/pending | GET | walletrpc.PendingSweeps |
| /v2/wallet/tapscript/import | POST | walletrpc.ImportTapscript |
| /v2/wallet/tx | POST | walletrpc.PublishTransaction |
| /v2/wallet/tx | GET | walletrpc.GetTransaction |
| /v2/wallet/tx/label | POST | walletrpc.LabelTransaction |
| /v2/wallet/utxos | POST | walletrpc.ListUnspent |
| /v2/wallet/utxos/lease | POST | walletrpc.LeaseOutput |
| /v2/wallet/utxos/leases | POST | walletrpc.ListLeases |
| /v2/wallet/utxos/release | POST | walletrpc.ReleaseOutput |
| /v2/watchtower/client | POST | wtclientrpc.AddTower |
| /v2/watchtower/client | GET | wtclientrpc.ListTowers |
| /v2/watchtower/client/info/{pubkey} | GET | wtclientrpc.GetTowerInfo |
| /v2/watchtower/client/policy | GET | wtclientrpc.Policy |
| /v2/watchtower/client/sessions/terminate/{session_id} | POST | wtclientrpc.TerminateSession |
| /v2/watchtower/client/stats | GET | wtclientrpc.Stats |
| /v2/watchtower/client/tower/deactivate/{pubkey} | POST | wtclientrpc.DeactivateTower |
| /v2/watchtower/client/{pubkey} | DELETE | wtclientrpc.RemoveTower |
| /v2/watchtower/server | GET | watchtowerrpc.GetInfo |