rootUnsubscribe

rootUnsubscribe WebSocket Method

post

Unsubscribe from root notifications. This method cancels an existing root subscription identified by the subscription ID that was returned from a previous rootSubscribe call. Once unsubscribed, you will no longer receive rootNotification messages when the validator sets new root slots.

Authorizations
Body

Request object for unsubscribing from root change notifications

jsonrpcstring · enumRequired

JSON-RPC protocol version

Example: 2.0Possible values:
idone ofRequired

Request identifier that will be returned in the response

Example: 1
stringOptional
or
numberOptional
methodstring · enumRequired

The WebSocket method name

Example: rootUnsubscribePossible values:
paramsinteger[] · min: 1 · max: 1Required

Method parameters array containing the root subscription ID to cancel

Example: [0]
Responses
200

Unsubscription successful

application/json
post
const ws = new WebSocket('wss://public.rpc.solanavibestation.com');
let subscriptionId = 0; // From previous rootSubscribe call

ws.onopen = function() {
  // Unsubscribe from root notifications
  ws.send(JSON.stringify({
    jsonrpc: '2.0',
    id: 1,
    method: 'rootUnsubscribe',
    params: [subscriptionId]
  }));
};

ws.onmessage = function(event) {
  const data = JSON.parse(event.data);
  
  if (data.result === true) {
    console.log('Successfully unsubscribed from root notifications:', subscriptionId);
  } else if (data.error) {
    console.error('Unsubscribe failed:', data.error);
  }
};
{
  "jsonrpc": "2.0",
  "result": true,
  "id": 1
}

Last updated