Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

About Breez SDK - Spark

Overview

The Breez SDK provides developers with an end-to-end solution for integrating instant, self-custodial bitcoin into their apps and services. It eliminates the need for third parties, simplifies the complexities of Bitcoin and Lightning, and enables seamless onboarding for billions of users to the future of value transfer.

What is the Breez SDK?

It’s a nodeless integration that offers a self-custodial, end-to-end solution for integrating bitcoin, utilizing the Bitcoin-native Layer 2 Lightning & Spark, with on-chain interoperability. Using the Breez SDK, you’ll be able to:

  • Send payments via various protocols such as: Lightning address, LNURL-Pay, Bolt11, BTC address, Spark address, BTKN
  • Receive payments via various protocols such as: Lightning address, LNURL-Pay, Bolt11, BTC address, Spark address, BTKN

Key Features

  • Send and receive Lightning payments
  • Send and receive via LNURL-pay & Lightning addresses
  • Send and receive Spark payments (BTC)
  • Issue, send and receive Spark tokens (BTKN)
  • On-chain interoperability
  • Convert Spark tokens (BTKN) to bitcoin and vice versa
  • Bindings to all popular languages & frameworks
  • Keys are only held by users
  • Multi-app & multi-device support via real-time sync service
  • Payments persistency including restore support
  • Automatic claims
  • WebAssembly support
  • Compatible with external signers
  • Free open-source solution

Pricing

The Breez SDK is free for developers.

Support

Have a question for the team? Join us on Telegram or email us at contact@breez.technology.

Repository

Head over to the Breez SDK - Spark repo.

Next Steps

Follow our step-by-step guide to add the Breez SDK to your app.

Getting Started