Getting Started
Integrating Breez SDK into your application takes just a few minutes. Follow these steps to get started:
- Installing the SDK
- Testing and development
- Initializing the SDK
- Fetching the balance
- Listening to events
- Adding logging
- Custom configuration
API Key
The Nodeless Breez API key must be set for the SDK to work. You can request one by filling our form here.
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
Looking for a quick way to try the SDK in your browser or as PWA? Check out our demo app Glow:
- Live demo: https://glow-app.co
- Repo: breez/breez-sdk-spark-example
Note: The 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.