WebSocket

WebSocket Transaction Subscriptions

Subscribe to real-time transaction logs and signature confirmations via WebSocket.

logsSubscribe

WebSocket - JSON-RPC

Subscribe to transaction logging to receive notifications with log output.

Parameters

params[0]string | objectrequired

Filter - one of:

  • "all" - all transactions except vote transactions
  • "allWithVotes" - all transactions including vote transactions
  • { "mentions": ["<pubkey>"] } - transactions mentioning an address
params[1]object

Configuration object:

  • commitment (string) - commitment level

Request

wscat -c wss://ws.nln.clr3.org -H "x-api-key: YOUR_API_KEY"> {"jsonrpc":"2.0","id":1,"method":"logsSubscribe","params":[{"mentions":["11111111111111111111111111111111"]},{"commitment":"finalized"}]}

Response

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

Notification Format

result.valueobject

signaturestring
Transaction signature.
errobject
Error if transaction failed (null on success).
logsarray
Array of log messages output during execution.

logsUnsubscribe

WebSocket - JSON-RPC

Cancel transaction logging notifications.

params[0]integerrequired

Subscription ID returned by logsSubscribe.

wscat -c wss://ws.nln.clr3.org -H "x-api-key: YOUR_API_KEY"> {"jsonrpc":"2.0","id":1,"method":"logsUnsubscribe","params":[0]}
Responsejson
{  "jsonrpc": "2.0",  "result": true,  "id": 1}

signatureSubscribe

WebSocket - JSON-RPC

Subscribe to receive a notification when the transaction with the given signature reaches the specified commitment level. The subscription is automatically cancelled after the notification is delivered.

Parameters

params[0]stringrequired

Transaction signature, base-58 encoded.

params[1]object

Configuration object:

  • commitment (string) - commitment level (default: finalized)
  • enableReceivedNotification (boolean) - receive notification when the transaction is received by the node

Request

wscat -c wss://ws.nln.clr3.org -H "x-api-key: YOUR_API_KEY"> {"jsonrpc":"2.0","id":1,"method":"signatureSubscribe","params":["2EBVM6cB8vAAD93Ktr6Vd8p67XPbQzCJX47MpReuiCXJAtcjaxpvWpcg9Ege1Nr5Tk3a2GFrByT7WPBjdsTycY9b",{"commitment":"finalized","enableReceivedNotification":false}]}

Response

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

Notification Format

result.valueobject

errobject
Error if transaction failed (null on success).

signatureUnsubscribe

WebSocket - JSON-RPC

Cancel signature confirmation notifications (if needed before delivery).

params[0]integerrequired

Subscription ID returned by signatureSubscribe.

wscat -c wss://ws.nln.clr3.org -H "x-api-key: YOUR_API_KEY"> {"jsonrpc":"2.0","id":1,"method":"signatureUnsubscribe","params":[0]}
Responsejson
{  "jsonrpc": "2.0",  "result": true,  "id": 1}