Skip to content

lexe-app/lexe-sidecar-sdk

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

54 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Lexe Sidecar SDK

The Lexe Sidecar SDK presents a simple JSON API for developers to control their self-custodial, always-online Lexe node which can send and receive payments over the Lightning Network. Running the lexe-sidecar binary spins up a local webserver (the "sidecar") at http://localhost:5393 which accepts REST requests and proxies them to your Lexe node. By making simple HTTP requests like

GET  http://localhost:5393/v2/node/node_info
GET  http://localhost:5393/v2/node/analyze
POST http://localhost:5393/v2/node/pay
POST http://localhost:5393/v2/node/create_invoice
POST http://localhost:5393/v2/node/pay_invoice
GET  http://localhost:5393/v2/node/payment

you can programmatically control your Lexe node. Your app can be written in any language, and is portable to any environment where the lexe-sidecar can run.

Install:

curl -fsSL https://lexe.app/install-sidecar.sh | sh

Docs:

About

Lexe Sidecar SDK: Control a Lexe node by sending REST requests to `localhost:5393`

Resources

License

Stars

Watchers

Forks

Contributors

Languages