getUtxosForDepositAddress

Get confirmed UTXOs for a deposit address.

Returns confirmed UTXOs for a Spark-generated Bitcoin deposit address.

Method Signature

async getUtxosForDepositAddress(
  depositAddress: string,
  limit?: number,
  offset?: number,
  excludeClaimed?: boolean
): Promise<{ txid: string; vout: number }[]>

Parameters

depositAddress · string · required

The Bitcoin deposit address to query (from getSingleUseDepositAddress() or getStaticDepositAddress())

limit · number

Maximum number of UTXOs to return (default: 100)

offset · number

Pagination offset (default: 0)

excludeClaimed · boolean

Whether to exclude already claimed UTXOs (default: false)

Returns

utxos · array · required

Array of UTXO objects with txid and vout

Example

const utxos = await wallet.getUtxosForDepositAddress(
  "bcrt1p...",
  100,
  0,
  true
);
console.log("UTXOs:", utxos);