Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Fetching the balance API docs

Once connected, the balance can be retrieved at any time.

Rust
let info = sdk.get_info(GetInfoRequest {}).await?;
let balance_sats = info.balance_sats;
Swift
let info = try await sdk.getInfo(request: GetInfoRequest())
let balanceSats = info.balanceSats
Kotlin
try {
    val info = sdk.getInfo(GetInfoRequest)
    val balanceSats = info.balanceSats
} catch (e: Exception) {
    // handle error
}
Javascript
const info = await sdk.getInfo({})
const balanceSats = info.balanceSats
React Native
const info = await sdk.getInfo({})
const balanceSats = info.balanceSats
Flutter
final info = await sdk.getInfo(request: GetInfoRequest());
final balanceSats = info.balanceSats;
Python
try:
    info = await sdk.get_info(request=GetInfoRequest())
    balance_sats = info.balance_sats
except Exception as error:
    logging.error(error)
    raise
Go
info, err := sdk.GetInfo(breez_sdk_spark.GetInfoRequest{})

if sdkErr := err.(*breez_sdk_spark.SdkError); sdkErr != nil {
    return err
}

balanceSats := info.BalanceSats
log.Printf("Balance: %v sats", balanceSats)

You are now ready to receive a Lightning payment.