Getting Started
Integrating Breez SDK - Nodeless (Liquid Implementation) into your application takes just a few minutes. Follow these steps to get started:
- Installing the SDK
- Connecting
- 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 for free by filling our form here.
Note: This is not the same as the Native (Greenlight) Breez API key, so it can't be reused.
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 Misty Breez, which you can use as the primary UX reference during SDK implementation.
Tutorials
How to Add Bitcoin Payments to React Native & Expo Apps
How to Add Bitcoin Payments to Flutter Apps
Misty Breez
Misty Breez is a mobile app built with Flutter that serves as a reference implementation for the Breez SDK - Nodeless that:
- Demonstrates the full capabilities of building with the SDK
- Showcases best practices for designing an intuitive UI and UX for self-custodial Lightning payments
- Offers a ready-made solution that can be white-labeled for partners looking to build a new app
Support
Have a question for the team? Join us on Telegram or email us at contact@breez.technology.