Skip to main content

Lightning Terminal (LiT)

Welcome to the API reference documentation for Lightning Terminal (LiT).

Lightning Terminal (LiT) is a browser-based interface for managing channel liquidity.

Features​

  • Visualize your channels and balances
  • Perform submarine swaps via the Lightning Loop service
  • Classify channels according to your node's operating mode
  • Run a single binary that integrates loopd, poold and faraday daemons all in one
  • Access a preview release of the Pool UI
  • Use Pool to earn sats by opening channels to those needing inbound liquidity

Usage​

Learn how to install, configure, and use LiT by viewing the documentation in the Builder's Guide.

Summary​

This site features the documentation for litcli (CLI), and the API documentation for Python and JavaScript clients in order to communicate with a local litd instance through gRPC.

gRPC​

The code samples assume that the there is a local litd instance running and listening for gRPC connections on port 8443. LIT_DIR will be used as a placeholder to denote the base directory of the litd instance. By default, this is ~/.lit on Linux and ~/Library/Application Support/Lit on macOS.

At the time of writing this documentation, two things are needed in order to make a gRPC request to an litd instance: a TLS/SSL connection and a macaroon used for RPC authentication. The code samples will show how these can be used in order to make a successful, secure, and authenticated gRPC request.

The original *.proto files from which the gRPC documentation was generated can be found here:

REST​

View a listing of all REST URLs on the REST Endpoints page.

The code samples assume that the there is a local litd instance running and listening for REST connections on port 8443. LIT_DIR will be used as a placeholder to denote the base directory of the litd instance. By default, this is ~/.lit on Linux and ~/Library/Application Support/Lit on macOS.

At the time of writing this documentation, two things are needed in order to make an HTTP request to an litd instance: a TLS/SSL connection and a macaroon used for RPC authentication. The code samples will show how these can be used in order to make a successful, secure, and authenticated HTTP request.

The original *.swagger.json files from which the gRPC documentation was generated can be found here:

REST Encoding​

NOTE: The byte field type must be set as the base64 encoded string representation of a raw byte array. Also, any time this must be used in a URL path (ie. /v1/abc/xyz/{payment_hash}) the base64 string must be encoded using a URL and Filename Safe Alphabet. This means you must replace + with -, / with _, and keep the trailing = as is. Url encoding (ie. %2F) will not work.

This documentation was generated automatically against commit 1463e9cb2e7141933adcf1b1e0f66e639cabc38b.