Installing the SDK

The Breez SDK is available in the following platforms:

iOS/Swift

We support integration via the Swift Package Manager and via CocoaPods. See breez/breez-sdk-spark-swift for more information.

Swift Package Manager

Installation via Xcode

Via File > Add Packages..., add

https://github.com/breez/breez-sdk-spark-swift.git

as a package dependency in Xcode.

Installation via Swift Package Manifest

Add the following to the dependencies array of your Package.swift:

.package(url: "https://github.com/breez/breez-sdk-spark-swift.git", from: "0.2.1"),

CocoaPods

Add the Breez SDK to your Podfile like so:

target '<YourApp>' do
  use_frameworks!
  pod 'BreezSdkSpark'
end

Android/Kotlin

We recommend integrating the Breez SDK as Gradle dependency from our Maven repository.

To do so, add the following to your Gradle dependencies:

repositories {
  maven {
      url("https://mvn.breez.technology/releases")
  }
}

dependencies {
  implementation("breez_sdk_spark:bindings-android:0.2.1")
}

Javascript/Typescript (Wasm)

We recommend using the official npm package: @breeztech/breez-sdk-spark.

Note: If using Node.js, the minimum supported version is v22.

npm install @breeztech/breez-sdk-spark

or

yarn add @breeztech/breez-sdk-spark

React Native

We recommend using the official npm package: @breeztech/breez-sdk-spark-react-native.

npm install @breeztech/breez-sdk-spark-react-native

or

yarn add @breeztech/breez-sdk-spark-react-native

Rust

We recommend to add breez sdk as a git dependency with a specific release tag. Check breez/spark-sdk for the latest version.

[dependencies]
breez-sdk-spark = { git = "https://github.com/breez/spark-sdk", tag = "0.2.1" }

Flutter

We recommend to add our official flutter package as a git dependency.

dependencies:
  breez_sdk_spark_flutter:
    git:
      url: https://github.com/breez/breez-sdk-spark-flutter

Go

We recommend using our official Go package: breez/breez-sdk-spark-go.

go get github.com/breez/breez-sdk-spark-go

Python

We recommend using our official Python package: breez-sdk-spark.

pip install breez-sdk-spark