Skip to main content

REST Endpoints

Here's a list of all the REST API endpoints available in LND.

REST PathREST MethodRPC
/v1/aliases/listGETlnrpc.ListAliases
/v1/balance/blockchainGETlnrpc.WalletBalance
/v1/balance/channelsGETlnrpc.ChannelBalance
/v1/changepasswordPOSTlnrpc.ChangePassword
/v1/channelsGETlnrpc.ListChannels
/v1/channelsPOSTlnrpc.OpenChannelSync
/v1/channels/{channel_point.funding_txid_str}/{channel_point.output_index}DELETElnrpc.CloseChannel
/v1/channels/abandon/{channel_point.funding_txid_str}/{channel_point.output_index}DELETElnrpc.AbandonChannel
/v1/channels/acceptorPOSTlnrpc.ChannelAcceptor
/v1/channels/backupGETlnrpc.ExportAllChannelBackups
/v1/channels/backup/{chan_point.funding_txid_str}/{chan_point.output_index}GETlnrpc.ExportChannelBackup
/v1/channels/backup/restorePOSTlnrpc.RestoreChannelBackups
/v1/channels/backup/subscribeGETlnrpc.SubscribeChannelBackups
/v1/channels/backup/verifyPOSTlnrpc.VerifyChanBackup
/v1/channels/batchPOSTlnrpc.BatchOpenChannel
/v1/channels/closedGETlnrpc.ClosedChannels
/v1/channels/pendingGETlnrpc.PendingChannels
/v1/channels/streamPOSTlnrpc.OpenChannel
/v1/channels/subscribeGETlnrpc.SubscribeChannelEvents
/v1/channels/transaction-streamPOSTlnrpc.SendPayment
/v1/channels/transactionsPOSTlnrpc.SendPaymentSync
/v1/channels/transactions/routePOSTlnrpc.SendToRouteSync
/v1/chanpolicyPOSTlnrpc.UpdateChannelPolicy
/v1/custommessagePOSTlnrpc.SendCustomMessage
/v1/custommessage/subscribeGETlnrpc.SubscribeCustomMessages
/v1/debuglevelPOSTlnrpc.DebugLevel
/v1/feesGETlnrpc.FeeReport
/v1/funding/stepPOSTlnrpc.FundingStateStep
/v1/genseedGETlnrpc.GenSeed
/v1/getinfoGETlnrpc.GetInfo
/v1/getrecoveryinfoGETlnrpc.GetRecoveryInfo
/v1/graphGETlnrpc.DescribeGraph
/v1/graph/edge/{chan_id}GETlnrpc.GetChanInfo
/v1/graph/infoGETlnrpc.GetNetworkInfo
/v1/graph/node/{pub_key}GETlnrpc.GetNodeInfo
/v1/graph/nodemetricsGETlnrpc.GetNodeMetrics
/v1/graph/routes/{pub_key}/{amt}GETlnrpc.QueryRoutes
/v1/graph/subscribeGETlnrpc.SubscribeChannelGraph
/v1/htlc/{chan_id}/{htlc_index}GETlnrpc.LookupHtlc
/v1/initwalletPOSTlnrpc.InitWallet
/v1/invoice/{r_hash_str}GETlnrpc.LookupInvoice
/v1/invoicesPOSTlnrpc.AddInvoice
/v1/invoicesGETlnrpc.ListInvoices
/v1/invoices/subscribeGETlnrpc.SubscribeInvoices
/v1/macaroonPOSTlnrpc.BakeMacaroon
/v1/macaroon/{root_key_id}DELETElnrpc.DeleteMacaroonID
/v1/macaroon/checkpermissionsPOSTlnrpc.CheckMacaroonPermissions
/v1/macaroon/idsGETlnrpc.ListMacaroonIDs
/v1/macaroon/permissionsGETlnrpc.ListPermissions
/v1/middlewarePOSTlnrpc.RegisterRPCMiddleware
/v1/newaddressGETlnrpc.NewAddress
/v1/paymentDELETElnrpc.DeletePayment
/v1/paymentsGETlnrpc.ListPayments
/v1/paymentsDELETElnrpc.DeleteAllPayments
/v1/payreq/{pay_req}GETlnrpc.DecodePayReq
/v1/peersPOSTlnrpc.ConnectPeer
/v1/peersGETlnrpc.ListPeers
/v1/peers/{pub_key}DELETElnrpc.DisconnectPeer
/v1/peers/subscribeGETlnrpc.SubscribePeerEvents
/v1/signmessagePOSTlnrpc.SignMessage
/v1/stateGETlnrpc.GetState
/v1/state/subscribeGETlnrpc.SubscribeState
/v1/stopPOSTlnrpc.StopDaemon
/v1/switchPOSTlnrpc.ForwardingHistory
/v1/transactionsGETlnrpc.GetTransactions
/v1/transactionsPOSTlnrpc.SendCoins
/v1/transactions/feeGETlnrpc.EstimateFee
/v1/transactions/manyPOSTlnrpc.SendMany
/v1/transactions/subscribeGETlnrpc.SubscribeTransactions
/v1/unlockwalletPOSTlnrpc.UnlockWallet
/v1/utxosGETlnrpc.ListUnspent
/v1/verifymessagePOSTlnrpc.VerifyMessage
/v2/autopilot/modifyPOSTautopilotrpc.ModifyStatus
/v2/autopilot/scoresGETautopilotrpc.QueryScores
/v2/autopilot/scoresPOSTautopilotrpc.SetScores
/v2/autopilot/statusGETautopilotrpc.Status
/v2/chainkit/bestblockGETchainrpc.GetBestBlock
/v2/chainkit/blockGETchainrpc.GetBlock
/v2/chainkit/blockhashGETchainrpc.GetBlockHash
/v2/chainnotifier/register/blocksPOSTchainrpc.RegisterBlockEpochNtfn
/v2/chainnotifier/register/confirmationsPOSTchainrpc.RegisterConfirmationsNtfn
/v2/chainnotifier/register/spendsPOSTchainrpc.RegisterSpendNtfn
/v2/dev/importgraphPOSTdevrpc.ImportGraph
/v2/invoices/cancelPOSTinvoicesrpc.CancelInvoice
/v2/invoices/hodlPOSTinvoicesrpc.AddHoldInvoice
/v2/invoices/lookupGETinvoicesrpc.LookupInvoiceV2
/v2/invoices/settlePOSTinvoicesrpc.SettleInvoice
/v2/invoices/subscribe/{r_hash}GETinvoicesrpc.SubscribeSingleInvoice
/v2/neutrino/addpeerPOSTneutrinorpc.AddPeer
/v2/neutrino/block/{hash}GETneutrinorpc.GetBlock
/v2/neutrino/blockhash/{height}GETneutrinorpc.GetBlockHash
/v2/neutrino/blockheader/{hash}GETneutrinorpc.GetBlockHeader
/v2/neutrino/cfilter/{hash}GETneutrinorpc.GetCFilter
/v2/neutrino/disconnectPOSTneutrinorpc.DisconnectPeer
/v2/neutrino/isbannedGETneutrinorpc.IsBanned
/v2/neutrino/statusGETneutrinorpc.Status
/v2/peers/nodeannouncementPOSTpeersrpc.UpdateNodeAnnouncement
/v2/router/htlceventsGETrouterrpc.SubscribeHtlcEvents
/v2/router/htlcinterceptorPOSTrouterrpc.HtlcInterceptor
/v2/router/mcGETrouterrpc.QueryMissionControl
/v2/router/mc/probability/{from_node}/{to_node}/{amt_msat}GETrouterrpc.QueryProbability
/v2/router/mc/resetPOSTrouterrpc.ResetMissionControl
/v2/router/mccfgGETrouterrpc.GetMissionControlConfig
/v2/router/mccfgPOSTrouterrpc.SetMissionControlConfig
/v2/router/paymentsGETrouterrpc.TrackPayments
/v2/router/routePOSTrouterrpc.BuildRoute
/v2/router/route/estimatefeePOSTrouterrpc.EstimateRouteFee
/v2/router/route/sendPOSTrouterrpc.SendToRouteV2
/v2/router/sendPOSTrouterrpc.SendPaymentV2
/v2/router/track/{payment_hash}GETrouterrpc.TrackPaymentV2
/v2/router/updatechanstatusPOSTrouterrpc.UpdateChanStatus
/v2/router/x/importhistoryPOSTrouterrpc.XImportMissionControl
/v2/signer/inputscriptPOSTsignrpc.ComputeInputScript
/v2/signer/musig2/cleanupPOSTsignrpc.MuSig2Cleanup
/v2/signer/musig2/combinekeysPOSTsignrpc.MuSig2CombineKeys
/v2/signer/musig2/combinesigPOSTsignrpc.MuSig2CombineSig
/v2/signer/musig2/createsessionPOSTsignrpc.MuSig2CreateSession
/v2/signer/musig2/registernoncesPOSTsignrpc.MuSig2RegisterNonces
/v2/signer/musig2/signPOSTsignrpc.MuSig2Sign
/v2/signer/sharedkeyPOSTsignrpc.DeriveSharedKey
/v2/signer/signmessagePOSTsignrpc.SignMessage
/v2/signer/signrawPOSTsignrpc.SignOutputRaw
/v2/signer/verifymessagePOSTsignrpc.VerifyMessage
/v2/versioner/versionGETverrpc.GetVersion
/v2/wallet/accountsGETwalletrpc.ListAccounts
/v2/wallet/accounts/importPOSTwalletrpc.ImportAccount
/v2/wallet/address/nextPOSTwalletrpc.NextAddr
/v2/wallet/addressesGETwalletrpc.ListAddresses
/v2/wallet/bumpfeePOSTwalletrpc.BumpFee
/v2/wallet/estimatefee/{conf_target}GETwalletrpc.EstimateFee
/v2/wallet/keyPOSTwalletrpc.DeriveKey
/v2/wallet/key/importPOSTwalletrpc.ImportPublicKey
/v2/wallet/key/nextPOSTwalletrpc.DeriveNextKey
/v2/wallet/psbt/finalizePOSTwalletrpc.FinalizePsbt
/v2/wallet/psbt/fundPOSTwalletrpc.FundPsbt
/v2/wallet/psbt/signPOSTwalletrpc.SignPsbt
/v2/wallet/reserveGETwalletrpc.RequiredReserve
/v2/wallet/sendPOSTwalletrpc.SendOutputs
/v2/wallet/sweepsGETwalletrpc.ListSweeps
/v2/wallet/sweeps/pendingGETwalletrpc.PendingSweeps
/v2/wallet/tapscript/importPOSTwalletrpc.ImportTapscript
/v2/wallet/txPOSTwalletrpc.PublishTransaction
/v2/wallet/tx/labelPOSTwalletrpc.LabelTransaction
/v2/wallet/utxosPOSTwalletrpc.ListUnspent
/v2/wallet/utxos/leasePOSTwalletrpc.LeaseOutput
/v2/wallet/utxos/leasesPOSTwalletrpc.ListLeases
/v2/wallet/utxos/releasePOSTwalletrpc.ReleaseOutput
/v2/watchtower/clientPOSTwtclientrpc.AddTower
/v2/watchtower/clientGETwtclientrpc.ListTowers
/v2/watchtower/client/{pubkey}DELETEwtclientrpc.RemoveTower
/v2/watchtower/client/info/{pubkey}GETwtclientrpc.GetTowerInfo
/v2/watchtower/client/policyGETwtclientrpc.Policy
/v2/watchtower/client/statsGETwtclientrpc.Stats
/v2/watchtower/serverGETwatchtowerrpc.GetInfo