Ctrl+K

Lightning - Get node state

get/api/v2/{coin}/wallet/{walletId}/state

This is only used for self-custody lightning. Get the current state of the lightning node.

Path Parameters

  • coinstringRequired
    A lightning coin name.
    Example: lnbtc
  • walletIdstringRequired
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$

200 Response

state string
Current state of the node
Allowed values: NON_EXISTING LOCKED UNLOCKED RPC_ACTIVE SERVER_ACTIVE WAITING_TO_START

400 Response

One of
error string required
Human-readable error message
requestId string required
Client request id
context object
Properties that apply to a specific error name
name string required
Error code