After connecting to the RPC PubSub websocket at ws://<ADDRESS>/:
Submit subscription requests to the websocket using the methods below
Multiple subscriptions may be active at once
Many subscriptions take the optional commitment parameter, defining how finalized a change should be to trigger a notification. For subscriptions, if commitment is unspecified, the default value is "finalized".
accountSubscribe#
Subscribe to an account to receive notifications when the lamports or data for a given account public key changes
Parameters:#
<string> - account Pubkey, as base-58 encoded string
(optional) <object> - Configuration object containing the following optional fields:
(optional) commitment: <string> - Commitment
encoding: <string> - encoding for Account data, either "base58" (slow), "base64", "base64+zstd" or "jsonParsed". "jsonParsed" encoding attempts to use program-specific state parsers to return more human-readable and explicit account state data. If "jsonParsed" is requested but a parser cannot be found, the field falls back to binary encoding, detectable when the data field is type <string>.
Results:#
<number> - Subscription id (needed to unsubscribe)
This subscription is unstable and only available if the validator was started with the --rpc-pubsub-enable-block-subscription flag. The format of this subscription may change in the future
Subscribe to receive notification anytime a new block is Confirmed or Finalized. Parameters:#
filter: <string>|<object> - filter criteria for the logs to receive results by account type; currently supported:
"all" - include all transactions in block
{ "mentionsAccountOrProgram": <string> } - return only transactions that mention the provided public key (as base-58 encoded string). If no mentions in a given block, then no notification will be sent.
(optional) <object> - Configuration object containing the following optional fields:
(optional) commitment: <string> - Commitment
(optional) encoding: <string> - encoding for Account data, either "base58" (slow), "base64", "base64+zstd" or "jsonParsed". "jsonParsed" encoding attempts to use program-specific state parsers to return more human-readable and explicit account state data. If "jsonParsed" is requested but a parser cannot be found, the field falls back to base64 encoding, detectable when the data field is type <string>. Default is "base64".
(optional) transactionDetails: <string> - level of transaction detail to return, either "full", "signatures", or "none". If parameter not provided, the default detail level is "full".
(optional) showRewards: bool - whether to populate the rewards array. If parameter not provided, the default includes rewards.
filter: <string>|<object> - filter criteria for the logs to receive results by account type; currently supported:
"all" - subscribe to all transactions except for simple vote transactions
"allWithVotes" - subscribe to all transactions including simple vote transactions
{ "mentions": [ <string> ] } - subscribe to all transactions that mention the provided Pubkey (as base-58 encoded string)
(optional) <object> - Configuration object containing the following optional fields:
(optional) commitment: <string> - Commitment
Results:#
<integer> - Subscription id (needed to unsubscribe)
The notification will be an RpcResponse JSON object with value equal to:
signature: <string> - The transaction signature base58 encoded.
err: <object|null> - Error if transaction failed, null if transaction succeeded. TransactionError definitions
logs: <array|null> - Array of log messages the transaction instructions output during execution, null if simulation failed before the transaction was able to execute (for example due to an invalid blockhash or signature verification failure)
Subscribe to a program to receive notifications when the lamports or data for a given account owned by the program changes
Parameters:#
<string> - program_id Pubkey, as base-58 encoded string
(optional) <object> - Configuration object containing the following optional fields:
(optional) commitment: <string> - Commitment
encoding: <string> - encoding for Account data, either "base58" (slow), "base64", "base64+zstd" or "jsonParsed". "jsonParsed" encoding attempts to use program-specific state parsers to return more human-readable and explicit account state data. If "jsonParsed" is requested but a parser cannot be found, the field falls back to base64 encoding, detectable when the data field is type <string>.
(optional) filters: <array> - filter results using various filter objects; account must meet all filter criteria to be included in results
Results:#
<integer> - Subscription id (needed to unsubscribe)
Subscribe to a transaction signature to receive notification when the transaction is confirmed On signatureNotification, the subscription is automatically cancelled
Parameters:#
<string> - Transaction Signature, as base-58 encoded string
(optional) <object> - Configuration object containing the following field:
(optional) commitment: <string> - Commitment
This subscription is unstable and only available if the validator was started with the --rpc-pubsub-enable-vote-subscription flag. The format of this subscription may change in the future
Subscribe to receive notification anytime a new vote is observed in gossip. These votes are pre-consensus therefore there is no guarantee these votes will enter the ledger.
The notification will be an object with the following fields:
hash: <string> - The vote hash
slots: <array> - The slots covered by the vote, as an array of u64 integers
timestamp: <i64|null> - The timestamp of the vote
signature: <string> - The signature of the transaction that contained this vote
{
"jsonrpc": "2.0",
"method": "voteNotification",
"params": {
"result": {
"hash": "8Rshv2oMkPu5E4opXTRyuyBeZBqQ4S477VG26wUTFxUM",
"slots": [1, 2],
"timestamp": null
},
"subscription": 0
}
}
