getTransfers

Gets all transfers for the SparkWallet.

getTransfers() includes Spark transfers, Lightning sends/receives, and cooperative exits (L1 withdrawals). For token transaction details (e.g., sender address), use queryTokenTransactionsWithFilters().

Method Signature

async getTransfers(
  limit: number = 20,
  offset: number = 0,
  createdAfter?: Date,
  createdBefore?: Date
): Promise<{
  transfers: WalletTransfer[];
  offset: number;
}>

Parameters

number

Maximum number of transfers to return (default: 20)

number

Offset for pagination (default: 0)

Date

Only return transfers created after this date (mutually exclusive with createdBefore)

Date

Only return transfers created before this date (mutually exclusive with createdAfter)

createdAfter and createdBefore are mutually exclusive. Providing both will throw an error.

Returns

WalletTransfer[]

required

Array of transfer objects

number

required

The offset used for this request

Example

// Basic pagination
const transfers = await wallet.getTransfers(10, 0);
console.log("Transfers:", transfers.transfers);
console.log("Offset:", transfers.offset);

// Get transfers from the last 24 hours
const yesterday = new Date(Date.now() - 24 * 60 * 60 * 1000);
const recentTransfers = await wallet.getTransfers(50, 0, yesterday);

// Get transfers before a specific date
const cutoffDate = new Date("2024-01-01");
const oldTransfers = await wallet.getTransfers(50, 0, undefined, cutoffDate);

getCachedBalance

getTransfer

⌘I

Introduction

Wallets

Wallet Viewer

Utilities

Issuance

getTransfers

Method Signature

Parameters

Returns

Example

​Method Signature

​Parameters

​Returns

​Example

Method Signature

Parameters

Returns

Example