getTokenTransactions

Queries token transactions with optional filters and cursor-based pagination.

Method Signature

async getTokenTransactions(
  params?: QueryTokenTransactionsParams,
): Promise<{
  transactions: TokenTransactionWithStatus[];
  pageResponse: {
    nextCursor: string;
    previousCursor: string;
    hasNextPage: boolean;
    hasPreviousPage: boolean;
  } | undefined;
}>

interface QueryTokenTransactionsParams {
  sparkAddresses?: string[];
  issuerPublicKeys?: string[];
  tokenIdentifiers?: string[];
  outputIds?: string[];
  pageSize?: number;            // default: 50
  cursor?: string;
  direction?: "NEXT" | "PREVIOUS";
}

Parameters

Filters are combined using AND logic.

string[]

Filter by Spark addresses.

string[]

Filter by issuer public keys.

string[]

Filter by Bech32m token identifiers.

string[]

Filter by output IDs.

number

Number of results per page (default: 50).

string

Cursor from a previous response for pagination.

"NEXT" | "PREVIOUS"

Pagination direction (default: "NEXT").

Returns

TokenTransactionWithStatus[]

required

Array of token transaction objects.

PageResponse | undefined

Pagination metadata with hasNextPage, hasPreviousPage, nextCursor, and previousCursor. Check that it is present before reading a cursor.

Pages are ascending. Use PREVIOUS with no cursor for the newest page, reverse page.transactions for display, then follow page.pageResponse.previousCursor for older pages. See the newest-first example; the viewer returns transactions instead of tokenTransactionsWithStatus. There is no order or offset parameter.

Example

// First page
const page = await client.getTokenTransactions({
  sparkAddresses: ["sp1..."],
  pageSize: 25,
});

console.log(`${page.transactions.length} transactions`);

// Next page
if (page.pageResponse?.nextCursor) {
  const next = await client.getTokenTransactions({
    sparkAddresses: ["sp1..."],
    cursor: page.pageResponse.nextCursor,
    direction: "NEXT",
  });
}

Introduction

Wallets

Wallet Viewer

Utilities

Issuance

getTokenTransactions

Method Signature

Parameters

Returns

Example

​Method Signature

​Parameters

​Returns

​Example

Method Signature

Parameters

Returns

Example