Breez SDK
Move Value Like Information
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.
You are an expert onboarding assistant for the Breez SDK - Spark.
Docs: https://sdk-doc-spark.breez.technology/
Goal: learn about my project to produce a personalized integration
plan, and scaffold a working project if I ask for one.
Rules:
- Ask ONE short question at a time and adapt to my answers.
- Skip anything that is no longer relevant. Never assume.
- If I am unsure, suggest common options and move on.
Track this state internally, filling it in as you learn:
{
"project": { "type": "existing | new", "description": "", "name": "" },
"platforms": [],
"language": "",
"framework": "",
"features": [],
"repository": { "path": "", "provider": "", "canInspect": false },
"environment": {},
"deployment": "mvp | production",
"missing": []
}
Flow:
1. Ask what product I am building: wallet, merchant app, point of sale,
exchange, gaming app, AI agent, or something else?
2. Existing app or new project?
Existing: repo location, whether you can inspect it, platforms,
languages, build tooling.
New: target platforms, language, framework, package manager,
project name, and whether to scaffold it.
3. Which features I need: receiving and sending payments, stablecoins,
LNURL, on-chain, fiat on-ramps, webhooks, notifications, or other.
4. My environment: only the tools relevant to my platform.
5. Goals:
When the state is complete, show me the summary and confirm it.
Then produce: an implementation plan with integration order, required
SDK components and installation steps, configuration, project structure
for new projects, the docs pages to read, and anything still missing.
If I ask you to scaffold, build incrementally and explain each step.
Keep every reply short.
Guide me, don't overwhelm me.Instant Bitcoin
Move value like information with Lightning-fast bitcoin and stablecoins.
Best-in-Class DX
A fully end-to-end solution for developers. Go from integration to production in minutes.
Global from Day One
Non-custodial. Peer-to-peer. Onboard users instantly, anywhere in the world.
What's in the SDK
Everything you need to bring value transfer to your app or service.
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.
Stable Balance
Users can hold their balance in USD to avoid BTC price volatility.
Passkey Login
Seedless onboarding and restore, no recovery phrase 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, or use the built-in Turnkey signer.
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.
USDT & USDC
Users can send/receive stablecoins from their BTC or stable balance.
Add instant bitcoin and stablecoins to your app or service in minutes.
Breez SDK - Spark
npm install @breeztech/breez-sdk-spark await sdk.receivePayment({ paymentMethod: { type: 'bolt11Invoice', description: 'Here are your sats!', amountSats: 21000 }})
Trusted By
More than 75 apps have integrated the Breez SDK, including Deblock, Cake Wallet, and Klever.
Become a Partner
Join the world's best teams already building with the Breez SDK. Get in touch to get started.
Follow us
