Alby Developer Guide
User GuideDeveloper Portal
Alby Wallet API
Alby Wallet API
  • Reference
    • ๐Ÿ”Œ Integration - Getting started
    • ๐Ÿ”’ Authorization
    • ๐Ÿ”— API Reference
      • Account
      • Invoices
      • Payments
      • Webhook Endpoints
  • โšก Lightning Address Details Proxy
Powered by GitBook
LogoLogo

Our content

  • Website
  • Blog
  • GitHub

Follow us

  • Nostr
  • Twitter / X
  • Youtube

Contact us

  • E-mail
  • Community Chat
  • Open Hours

Your bitcoin & nostr companion / from ๐Ÿ with ๐Ÿงก

On this page
  • Alby API Endpoint
  • Quickstart
  • Alby Packages
  • Community Packages

Was this helpful?

  1. Reference

๐Ÿ”Œ Integration - Getting started

Integrate Bitcoin Lightning functionality provided by the Alby Wallet into your applications, with the Alby Wallet API. Send & receive payments, create invoices, access Podcasting 2.0 and more!

Last updated 1 month ago

Was this helpful?

Welcome to the Alby Wallet API Integration Guide, your resource for integrating Bitcoin Lightning into your applications. This allows you to easily add bitcoin lightning with Alby API to your application. You can send and receive payments, 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: . To use this workspace in the browser, please fork it and use an access token from to test it out. If you have any issues, please let us know on .

Alby API Endpoint

All of the examples in this guide will use the production endpoint. Please be aware that you will be spending real sats when paying any invoice generated by this API.

https://api.getalby.com

Quickstart

  1. See the on how to obtain an access token

  2. Make a request using the access token in the Authorization header:

curl https://api.getalby.com/balance -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

You should now see a JSON response like that:

{
  "balance": 1000,
  "currency": "BTC",
  "unit": "sat"
}
  1. Make sure to always send payloads as JSON and include a content-type header (Content-Type: application/json)

Alby Packages

Community Packages

- Typescript package to integrate Alby Wallet API and

- PHP library to integrate the Alby Wallet API

- Python library to integrate the Alby Wallet API

- Swift SDK to integrate the Alby Wallet API

- Delphi/Lazarus library to integrate the Alby Wallet API

Check out the for a full overview of Alby's supported tools, APIs and packages to add lightning to your app.

https://www.postman.com/getalby/workspace/alby-workspace/
https://getalby.com/developer
telegram
Authorization page
Alby JS SDK
NWC
Alby PHP
pyalby
AlbyKit
Delphi/Lazarus
Alby developer portal