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
AuthorizationstringOptional

Authorization header for API key authentication.

Example:

Authorization: your-api-key-here
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
chevron-right
200

Unsubscription successful

application/json

Response indicating the success or failure of the root unsubscribe operation

jsonrpcstring · enumRequired

JSON-RPC protocol version

Example: 2.0Possible values:
idone ofRequired

Request identifier matching the original request

Example: 1
stringOptional
or
numberOptional
resultbooleanOptional

Unsubscribe success indicator. Returns true if the root subscription was successfully cancelled, false otherwise. A successful unsubscribe means you will no longer receive rootNotification messages when new root slots are set by the validator.

Example: true
post
/

Last updated