Getting started

With the Alby Wallet API you can integrate Bitcoin Lightning functionality provided by the Alby Wallet into your application.
This allows you to easily add receiving and sending payments to your application. You can get podcasting 2.0 details, create invoices, retrieve the user's incoming and outgoing payments, and make Lightning payments on behalf of users.
​
To test out the API using the Postman web client, check out our Postman workspace: https://www.postman.com/getalby/workspace/alby-workspace/. To use this workspace in the browser, please get in touch so we can add your account.

Environments

All of the examples in this guide will use the development endpoint. Make sure you exchange this endpoint before you launch your application.
🧑‍💻 Development
🔴 Production
https://api.regtest.getalby.com
https://api.getalby.com

Quickstart

  1. 1.
    See the Authorization page on how to obtain an access token
  2. 2.
    Make a request using the access token in the Authorization header:
curl https://api.regtest.getalby.com/balance -H Authorization: "Bearer $access_token"
You should now see a JSON response like that:
{
"balance": 1000,
"currency": "BTC",
"unit": "sat"
}
​
Last modified 3mo ago