📙Libraries

Integrating Boltz API is involved and not to be underestimated. To save on time and resources, we highly recommend exploring the different library options for Boltz API below.

TypeScript

boltz-core: Our reference library in TypeScript.

Used by e.g.: Boltz Web App and boltz-backend

Supported currencies: Bitcoin, Lightning, Liquid, Rootstock

Go

Boltz Client: Our reference client to accept Lightning payments and rebalance Lightning nodes; provides a fully fledged Go library for Boltz API.

Used by e.g.: Boltz BTCPay Plugin

Supported currencies: Bitcoin, Lightning, Liquid

Rust

boltz-rust: Boltz API library in Rust, developed and maintained by the amazing folks at Bull Bitcoin.

Used by e.g.: Bull Bitcoin Mobile and Aqua Wallet via Boltz Dart

Supported currencies: Bitcoin, Lightning, Liquid

Breez SDK - Liquid implementation: End-to-end solution for developers which includes a wallet, notification system, and bindings for Kotlin, Flutter, Python, React Native, and Swift.

Used by e.g.: StashPay

Supported currencies: Bitcoin, Lightning, Liquid

Python

Boltz Client Python: Currently unmaintained Boltz API client in Python; based on the deprecated Boltz API v1.

Used by e.g.: LNbits

Supported currencies: Bitcoin, Lightning, Liquid

Note: If Python is preferred, we recommend using the Breez SDK Liquid with Python bindings.