About Breez SDK
The Breez SDK is the simplest way to add instant, non‑custodial bitcoin and stablecoins to any app or service, removing third-party dependencies and enabling value to move as easily as information.
Integrate in minutes with just a few lines of code, onboard users anywhere without the licensing burden, and bring value transfer to billions around the world.
How the Breez SDK Works
The Breez SDK offers a non-custodial, end-to-end solution for integrating bitcoin and stablecoins. It’s a nodeless integration that utilizes the Bitcoin-native Layer 2 Lightning & Spark, with on-chain interoperability. Using the Breez SDK, you’ll be able to:
- Send and receive bitcoin via Lightning addresses, Bolt11 invoices, LNURL-Pay, bitcoin addresses, and Spark addresses
- Send and receive USDC or USDT on Ethereum, Base, Arbitrum, Solana, Tron, and other networks, to and from a bitcoin or USD balance
- Issue, send, and receive Spark tokens (BTKN)
Key Features
- Fully-featured Lightning: Lightning addresses, invoices, LNURL-Pay, -Withdraw, -Auth, and -Verify.
- Languages & Frameworks: Kotlin, Swift, JS, React Native, Flutter, Go, Python, C#, and WASM.
- Passkey Login: Seedless onboarding and restore, no recovery phrase needed.
- USDT & USDC: Users can send/receive stablecoins from their BTC or stable balance.
- Stable Balance: Users can hold their balance in USD to avoid BTC price volatility.
- Instant Deposits: Claim on-chain deposits in seconds, no confirmations needed.
- Multi-device/app Sync: Users can access their balance from multiple devices and apps.
- Contacts API: Save and reuse Lightning addresses, synced across devices.
- Caching & Persistence: Out-of-the-box caching and persistence for a smooth UX.
- External Signer: Bring your own key management.
- Turnkey Signer: A built-in signer for server-side, non-custodial embedded wallets.
- Integrated On-ramps: Let users buy bitcoin directly via Cash App and MoonPay.
- Fiat Currencies: Real-time exchange rates to display value in fiat currencies.
- Multi-user Server Mode: Run multiple user balances from a single backend server.
- Open-source: Free and open-source, available to any developer at any scale.
- Partner Portal: Track your volume and activity in one dashboard.
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.
API Key
The Breez SDK API key must be set for the SDK to work.
You can request one by filling out this form or programmatically with the following request:
curl -d "fullname=<full name>" -d "company=<company>" -d "email=<email>" -d "message=<message>" \
https://breez.technology/contact/apikey
The API key is sent to the provided email address.
Repository
Head over to the Breez SDK repo.
Next Steps
Follow our step-by-step guide to add the Breez SDK to your app or service.