Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.spark.money/llms.txt

Use this file to discover all available pages before exploring further.

Gets confirmed UTXOs for a specific Bitcoin deposit address with pagination.

​
Method Signature

async getUtxosForDepositAddress(params: GetUtxosParams): Promise<{
  utxos: { txid: string; vout: number }[];
  offset: number;
}>

interface GetUtxosParams {
  depositAddress: string;
  limit?: number;          // default: 100
  offset?: number;         // default: 0
  excludeClaimed?: boolean;
}

​
Parameters

​
depositAddress
string
required
The Bitcoin deposit address to query UTXOs for (e.g., "bc1...").
​
limit
number
Maximum number of UTXOs to return (default: 100).
​
offset
number
Offset for pagination (default: 0).
​
excludeClaimed
boolean
If true, excludes already-claimed UTXOs from results.

​
Returns

​
utxos
{ txid: string; vout: number }[]
required
Array of UTXO objects with transaction ID and output index.
​
offset
number
required
The offset used for this request.

​
Example

const { utxos } = await client.getUtxosForDepositAddress({
  depositAddress: "bc1...",
  excludeClaimed: true,
});

for (const utxo of utxos) {
  console.log(`${utxo.txid}:${utxo.vout}`);
}