Node Status

Returns information about your node.

Endpoint

GET /v1/status

Authentication

You must authenticate using the admin node's macaroon.

Request Parameters

There are no request parameters.

Response Parameters


ParamTypeDescription
aliasStringThe alias used to name your node on the lightning network
createdBooleanA flag for whether or not the admin node has been setup yet
runningBooleanA flag for whether or not the admin node is running
authenticatedBooleanA flag for whether or not this request was properly authenticated
pubkeyStringYour node public key. This is often described as your node's id
usernameStringThe username used to login to this node's admin panel
roleStringDesignates the type of node that was intialized