Helius SDK - v3.4.0
    Preparing search index...

    Interface ScanParsedTransactionHistoryRequest<S>

    Request parameters for parsedEvents.scan (POST /v1/parsed-events/scan). S types returnShape; it defaults to transactions, so use ScanParsedTransactionHistoryRequest<"count"> (or <ScanReturnShape>) for a request object you build ahead of the call with another shape.

    interface ScanParsedTransactionHistoryRequest<
        S extends ScanReturnShape = "transactions",
    > {
        address: string;
        afterSignature?: string;
        beforeSignature?: string;
        budget?: ScanBudget;
        commitment?: ParsedEventsCommitment;
        limit?: number;
        match: ScanMatch;
        minContextSlot?: number;
        paginationToken?: string | null;
        rawTransaction?: ParsedEventsRawTransactionEncoding;
        returnShape?: S;
        slot?: ComparisonBounds;
        sortOrder?: ParsedEventsSortOrder;
        status?: ParsedEventsStatusFilter;
        time?: ComparisonBounds;
        tokenAccounts?: ParsedEventsTokenAccountsFilter;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    address: string

    Address whose history is scanned. Prefer the narrowest address: every transaction it has counts toward the budget.

    afterSignature?: string

    Only transactions after this signature.

    beforeSignature?: string

    Only transactions before this signature.

    budget?: ScanBudget

    Limits on how much history this request scans.

    Commitment level. Defaults to confirmed.

    limit?: number

    Most matches to return with the transactions shape, an integer from 1 to 100. Defaults to 100. Ignored by signatures and count.

    match: ScanMatch

    What a transaction must match.

    minContextSlot?: number

    Minimum slot at which the request can be evaluated.

    paginationToken?: string | null

    Cursor returned by a previous request as paginationToken. null is ignored, so a response's token can be passed straight back.

    Return each original transaction as rawTransaction in this encoding. Defaults to none.

    returnShape?: S

    What the response carries for the matches. Defaults to transactions.

    Slot comparison bounds.

    Order in which history is walked and results are returned. Defaults to desc (newest first).

    Execution result to include. Defaults to succeeded, so failed transactions are left out unless you pass any or failed.

    Block-time comparison bounds in whole Unix seconds (e.g. Math.floor(Date.now() / 1000)).

    Transactions that reference only a token account owned by the address. Defaults to none (left out).