Voltage API (1.0.0)

Download OpenAPI specification:Download

This is the API Spec for the Voltage Public API. This is open for anyone to use and requires API Keys for Authentication.

Authentication

API Token

An API Key can be created on your Voltage Dashboard. See the documentation for more details. Example:

X-VOLTAGE-AUTH: v55c018bad2354035a34098f425d203c7

Security Scheme Type API Key
Header parameter name: X-VOLTAGE-AUTH

User

/user

Get details about the user

Authorizations:

Responses

Response samples

Content type
application/json
{
  • "user_id": "9e94432b-963b-41da-96a6-8731a80c811eU",
  • "email": "email@site.com",
  • "email_verified": true,
  • "mfa_enabled": false,
  • "trial_available": false,
  • "btcpayserver_trial": false,
  • "available_btcpayservers": 0,
  • "available_standard_nodes": 1,
  • "available_lite_nodes": 0,
  • "purchased_standard_nodes": 1,
  • "purchased_lite_nodes": 2
}

Node

/node

List all nodes for the user

Authorizations:

Responses

Response samples

Content type
application/json
{
  • "nodes": [
    ]
}

/node

Get information about a specific node

Authorizations:
Request Body schema: application/json
node_id
required
string

Voltage Node ID you're requesting

Responses

Request samples

Content type
application/json
{
  • "node_id": "555c5108-7438-488d-b227-5f80baf8a23aN"
}

Response samples

Content type
application/json
{
  • "node_name": "myvoltagenode",
  • "status": "running",
  • "node_id": "7b12b510-8633-4c49-af2b-9cb5b73d6feeN",
  • "expires": "never",
  • "created": "2021-08-29T18:55:12Z",
  • "type": "standard",
  • "purchased_type": "paid",
  • "purchase_status": "active",
  • "lnd_version": "0.13.1-beta",
  • "volt_version": "v0.3.0",
  • "update_available": false,
  • "api_endpoint": "myvoltagenode.m.voltageapp.io",
  • "network": "mainnet",
  • "command_history": [
    ],
  • "macaroons": [
    ],
  • "settings": {
    }
}

/node/create

Create an new Lightning Node

Authorizations:
Request Body schema: application/json
network
required
string

Network the node is running on. Can be either 'testnet' or 'mainnet'.

purchased_type
required
string

Purchase type of the node. Can be either 'trial', 'paid', or 'ondemand'.

type
required
string

Type of node, either 'standard' or 'lite'

name
required
string

User defined node name given at creation

required
object

Settings for the Lightning Node

Responses

Request samples

Content type
application/json
{
  • "network": "mainnet",
  • "purchased_type": "paid",
  • "type": "standard",
  • "name": "myvoltagenode",
  • "settings": {
    }
}

Response samples

Content type
application/json
{
  • "node_id": "8ac52ac6-b205-4051-8ac6-c538c2f269a0N",
  • "network": "mainnet",
  • "expires": "never",
  • "created": "2021-02-10T19:21:57Z",
  • "purchased_type": "paid",
  • "type": "standard",
  • "node_name": "myvoltagenode",
  • "api_endpoint": "myvoltagenode.m.voltageapp.io",
  • "status": "provisioning",
  • "purchase_status": "active",
  • "lnd_version": "pending",
  • "volt_version": "pending"
}

/node/stop

Stop a Node

Authorizations:
Request Body schema: application/json
node_id
required
string

Voltage Node ID you're requesting

Responses

Request samples

Content type
application/json
{
  • "node_id": "3ac8b9f5-6e7a-4727-abe4-5ae61587e8e5N"
}

Response samples

Content type
application/json
{
  • "node_name": "myvoltagenode",
  • "status": "stopping",
  • "node_id": "3ac8b9f5-6e7a-4727-abe4-5ae61587e8e5N",
  • "expires": "never",
  • "created": "2021-02-09T21:02:29Z",
  • "api_endpoint": "myvoltagenode.m.voltageapp.io",
  • "network": "mainnet",
  • "type": "standard"
}

/node/start

Start a node

Authorizations:
Request Body schema: application/json
node_id
required
string

Voltage Node ID you're requesting

Responses

Request samples

Content type
application/json
{
  • "node_id": "7b12b510-8633-4c49-af2b-9cb5b73d6feeN"
}

Response samples

Content type
application/json
{
  • "node_name": "myvoltagenode",
  • "status": "starting",
  • "node_id": "3ac8b9f5-6e7a-4727-abe4-5ae61587e8e5N",
  • "expires": "never",
  • "created": "2021-02-09T21:02:29Z",