index/interfaces/BasePaginationOptions.md

Base pagination options interface

Common pagination parameters shared across all paginated SDK methods. Extend this interface to create domain-specific pagination options. Uses cursor-based pagination exclusively.

Example

// Simple extension with no additional fields
export type FetchAllTokensOptions = BasePaginationOptions;

// Extension with additional filter fields
export interface FetchTokensHeldOptions extends BasePaginationOptions {
  tokenName?: string;
  search?: string;
}

Since

7.0.0

Updated

8.1.0 - Removed limit/offset, cursor-based pagination only

Extended by

• SearchablePaginationOptions
• TokenFilterPaginationOptions
• GetTradesOptions
• FetchTradesOptions
• ListBansOptions
• ListGlobalBansOptions
• ListModeratorInvitesOptions
• ListFlagsOptions
• ListGlobalFlagsOptions
• ListOverseerInvitesOptions
• ListOverseersOptions
• ListUsersOptions

Properties

Property	Type	Description
cursor?	string	Cursor token for fetching the next page (omit for first page) - for cursor-based pagination
pageSize?	number	Page size for cursor-based pagination (defaults to 50, max 1000)