Skip to main content
Gets paginated transfer history for a Spark address with optional date filters.

​
Method Signature

async getTransfers(params: QueryTransfersParams): Promise<{
  transfers: Transfer[];
  offset: number;
}>

interface QueryTransfersParams {
  sparkAddress: string;
  limit?: number;         // default: 20
  offset?: number;        // default: 0
  types?: TransferType[];
  createdAfter?: Date;
  createdBefore?: Date;
}

​
Parameters

​
sparkAddress
string
required
The Spark address to query transfers for.
​
limit
number
Maximum number of transfers to return (default: 20).
​
offset
number
Offset for pagination (default: 0).
​
types
TransferType[]
Filter by transfer types. Defaults to TRANSFER, PREIMAGE_SWAP, COOPERATIVE_EXIT, UTXO_SWAP.
​
createdAfter
Date
Only return transfers created after this date.
​
createdBefore
Date
Only return transfers created before this date.
createdAfter and createdBefore are mutually exclusive. Providing both will throw an error.

​
Returns

​
transfers
Transfer[]
required
Array of transfer objects.
​
offset
number
required
The offset used for this request.

​
Example

// Basic pagination
const { transfers, offset } = await client.getTransfers({
  sparkAddress: "sp1...",
  limit: 25,
  offset: 0,
});

// Transfers from the last 24 hours
const recent = await client.getTransfers({
  sparkAddress: "sp1...",
  createdAfter: new Date(Date.now() - 86_400_000),
});