Skip to content

getAlby/lightning-address-details-proxy

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

41 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

lightning-address-details-proxy

This proxy exists to simplify requests to lightning address providers.

  • Many ln addresses don't support CORS, which means fetching the data directly in a browser environment will not always work.
  • Two requests are required to retrieve lnurlp and keysend data for a lightning address. The proxy will do these for you with a single request.

API

Getting keysend and LNURLp info

GET /lightning-address-details?ln=<lightning_address>

Example

GET https://api.getalby.com/lnurl/lightning-address-details?ln=hello@getalby.com

Requesting a LNURLp invoice

GET /generate-invoice?ln=<lightning_address>&amount=<amount_in_millisats>&comment=<http_encoded_comment>

Please refer to the https://github.com/lnurl/luds (LUD-06, LUD-12, LUD-18) and any other LUD that extends the functionality of LUD-06 for more information on what parameters can be passed.

Example

GET https://api.getalby.com/lnurl/generate-invoice?ln=hello@getalby.com&amount=1000&comment=Hello%20Alby!


This proxy is used by Alby Tools

Development

cp .env.example .env

go run .

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors 4

  •  
  •  
  •  
  •