GET

Lightning - Get node state

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

Path Params

coin string required

A lightning coin name.
walletId string required

The wallet ID.

matches ^[0-9a-f]{32}$

Responses

200

Response Body

object

state string enum

Current state of the node

NON_EXISTINGLOCKEDUNLOCKEDRPC_ACTIVESERVER_ACTIVEWAITING_TO_START

400

Bad Request

Response Body

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

error string required

Human-readable error message
requestId string required

Client request id
context object required
context object
- id string
  
  matches ^[0-9a-f]{32}$
name string enum required

Error code

InvalidWalletId

const url = 'http://localhost:3080/api/v2/coin/wallet/walletId/state'; const options = {method: 'GET', headers: {accept: 'application/json', 'Authorization': 'Bearer YOUR_ACCESS_TOKEN'}}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error(err));

require 'uri' require 'net/http' url = URI("http://localhost:3080/api/v2/coin/wallet/walletId/state") http = Net::HTTP.new(url.host, url.port) request = Net::HTTP::Get.new(url) request["accept"] = 'application/json' request["Authorization"] = 'Bearer YOUR_ACCESS_TOKEN' response = http.request(request) puts response.read_body

<?php require_once('vendor/autoload.php'); $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'http://localhost:3080/api/v2/coin/wallet/walletId/state', [ 'headers' => [ 'accept' => 'application/json', 'Authorization' => 'Bearer YOUR_ACCESS_TOKEN', ], ]); echo $response->getBody();

import requests url = "http://localhost:3080/api/v2/coin/wallet/walletId/state" headers = { "accept": "application/json", "Authorization": "Bearer YOUR_ACCESS_TOKEN" } response = requests.get(url, headers=headers) print(response.text)