getAvailableBalance

Gets the available Bitcoin balance in satoshis for a Spark address. Automatically paginates through all wallet nodes. The viewer does not claim incoming transfers. A pending receipt can exist while both available and owned balances are zero; see balance semantics. Private wallets also return empty results to unauthorized clients, so emptiness is not a permission check.

Method Signature

async getAvailableBalance(sparkAddress: string): Promise<bigint>

Parameters

string

required

The Spark address to query (e.g., "sp1...").

Returns

bigint

required

Available balance in satoshis. Returns 0n for private wallets queried without authentication.

Example

const balance = await client.getAvailableBalance("sp1...");
console.log("Balance:", balance, "sats");
console.log("Balance (BTC):", Number(balance) / 1e8);

Introduction

Wallets

Wallet Viewer

Utilities

Issuance

getAvailableBalance

Method Signature

Parameters

Returns

Example

​Method Signature

​Parameters

​Returns

​Example

Method Signature

Parameters

Returns

Example