Getting Started

Integrating Breez SDK into your product takes just a few minutes. Follow these steps to get started:

• Installing the SDK
• Testing and development
• Initializing the SDK
  • Customizing the SDK
• Getting the SDK info
• Listening to events
• Adding logging
• Spark status

Languages & Frameworks

The Breez SDK is available for the following languages and frameworks:

• iOS/Swift
• Android/Kotlin
• Kotlin Multiplatform
• Javascript/Typescript (Wasm)
• React Native/Expo
• Rust
• Flutter
• Go
• Python
• C#

API Key

The Breez SDK API key must be set for the SDK to work. The API key is sent to the provided email address.

Request an API key

Or request one programmatically with the following request:

curl https://breez.technology/contact/apikey \
  -d "fullname=<full name>" \
  -d "company=<company>" \
  -d "email=<email>" \
  -d "message=<message>"

UX Guidelines

When implementing the Breez SDK, we recommend reading through our UX Guidelines to provide a consistent and intuitive experience for your end-users.

Many of the guidelines are implemented in Glow, which you can use as a UX reference during SDK implementation.

Demo

Glow is a bitcoin and stablecoins app, powered by the Breez SDK. Users experience the best of bitcoin UX. Developers get a production-ready reference to explore, fork, and ship.

• Download Glow on the App Store
• Get Glow on Google Play
• Repository

Looking for a quick way to try the SDK in your browser or as PWA? Check out the Glow web demo:

• Live demo: https://glow-app.co
• Repository: breez/glow-web

Note: The web demo is for demonstration purposes only and not intended for production use.

Support

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