signatureSubscribe

Subscribe to receive a notification when the transaction with the given signature reaches the specified commitment level.

This is a subscription to a single notification. It is automatically cancelled by the server once the notification, signatureNotification, is sent by the RPC.

Endpoints

Websockets are available on mainnet and devnet with the following URLs:

• Mainnet wss://mainnet.helius-rpc.com/?api-key=<API_KEY>
• Devnet wss://devnet.helius-rpc.com/?api-key=<API_KEY>

Websockets have a 10-minute inactivity timer; implementing health checks and sending pings every minute is heavily recommended to keep the websocket connection alive.

Authorizations

api-key · string · required

Your Helius API key. You can get one for free in the dashboard.

Body

params · array · required

Hide properties

signature · string · required

Transaction signature, as base-58 encoded string.

The transaction signature must be the first signature from the transaction (see transaction id for more details).

config · object

Configuration object containing the following fields:

commitment · string

The commitment level for the subscription. Can be finalized, confirmed, or processed.

enableReceivedNotification · boolean

Whether to send a notification when the transaction signature is received.

Response

result · integer

Subscription id (needed to unsubscribe)

Notification Format

The notification will be an RpcResponse JSON object with value containing an object with:

• slot: <u64> - The corresponding slot.
• value: <object|string> - a notification value of RpcSignatureResult, resulting in either:
  • when enableReceivedNotification is true and the signature is received: the literal string "receivedSignature", or
  • when the signature is processed: err: <object|null>:
    • null if the transaction succeeded in being processed at the specified commitment level, or
    • a TransactionError, if the transaction failed

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "signatureSubscribe",
  "params": [
    "2EBVM6cB8vAAD93Ktr6Vd8p67XPbQzCJX47MpReuiCXJAtcjaxpvWpcg9Ege1Nr5Tk3a2GFrByT7WPBjdsTycY9b",
    {
      "commitment": "finalized",
      "enableReceivedNotification": false
    }
  ]
}

Response

{
  "jsonrpc": "2.0",
  "result": 0,
  "id": 1
}