This WebSocket method is billed based on metered data usage: 0.1 MB = 15 API credits. Learn more about WebSocket billing.

Parameters

filter

object

(Optional) A filter object specifying which pre-execution transactions to receive notifications for. All fields are optional. Account filters match static account keys plus resolved Address Lookup Table (ALT) loaded addresses. Version 1 transactions carry every account inline, so no ALT resolution is involved.

vote

boolean

If true, deliver only simple vote transactions; if false, exclude simple vote transactions; if omitted, include both. Matches Agave's simple-vote transaction classification — it does not match any transaction that merely contains a Vote program instruction

signature

string

Deliver only the transaction with the given signature (base-58 encoded string)

accounts

object

Account-based filtering with the following fields:

include

array

A list of account addresses (base-58 encoded strings) — deliver transactions that touch at least one listed account

exclude

array

A list of account addresses (base-58 encoded strings) — drop transactions that touch any listed account

required

array

A list of account addresses (base-58 encoded strings) — deliver only transactions that touch all listed accounts

Returns

result

integer

The subscription id (needed to unsubscribe)

shredTransactionNotification

object

The notification object with the following fields:

result

object

An object containing the notification context and value:

context

object

Context information, including the slot the transaction was observed in

value

object

Pre-execution transaction data with the following fields:

slot

integer

The slot the transaction was observed in

signature

string

The transaction signature

transaction

object

The decoded transaction containing the signatures array and the message (header, accountKeys, recentBlockhash, instructions, and addressTableLookups). Version 1 messages carry transactionConfig in place of addressTableLookups. Each instruction includes programIdIndex, accounts, data, and stackHeight; stackHeight is always 1 because only static, top-level instructions exist before execution. No execution metadata is included

version

string|integer

The transaction version, one of 'legacy', 0, or 1

loadedAddresses

object|null

For v0 transactions, the addresses resolved from Address Lookup Tables, with 'writable' and 'readonly' arrays. Set to null when one or more lookup tables cannot be resolved. Omitted for legacy and version 1 transactions

subscription

integer

The subscription id that produced the notification

Request

1
wscat -c  \
2
# wait for connection
3
{"id":1,"jsonrpc":"2.0","method":"shredTransactionSubscribe","params":[{"vote":false,"accounts":{"include":["TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA"]}}]}

1
wscat -c  \
2
# wait for connection
3
{"id":1,"jsonrpc":"2.0","method":"shredTransactionSubscribe","params":[{"vote":false,"accounts":{"include":["TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA"]}}]}

Response

1
{
2
  "jsonrpc": "2.0",
3
  "result": 2440271,
4
  "id": 1
5
}

1
{
2
  "jsonrpc": "2.0",
3
  "result": 2440271,
4
  "id": 1
5
}

Don't have an account yet?

Create your Quicknode endpoint in seconds and start building

Get started for free