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 unused deposit addresses for a Spark address with pagination.

​
Method Signature

async getUnusedDepositAddresses(
  params: QueryDepositAddressesParams,
): Promise<{
  depositAddresses: DepositAddressQueryResult[];
  offset: number;
}>

interface QueryDepositAddressesParams {
  sparkAddress: string;
  limit?: number;   // default: 100
  offset?: number;  // default: 0
}

​
Parameters

​
sparkAddress
string
required
The Spark address to query deposit addresses for.
​
limit
number
Maximum number of addresses to return (default: 100).
​
offset
number
Offset for pagination (default: 0).

​
Returns

​
depositAddresses
DepositAddressQueryResult[]
required
Array of unused deposit address objects.
​
offset
number
required
The offset used for this request.

​
Example

const { depositAddresses } = await client.getUnusedDepositAddresses({
  sparkAddress: "sp1...",
  limit: 50,
});

for (const addr of depositAddresses) {
  console.log(addr);
}