Skip to main content

slotUnsubscribe

The Solana slotUnsubscribe method cancels a slot subscription created by slotSubscribe so that slot processing notifications are no longer received.

Usage Notes
  • Must be called via a WebSocket endpoint; HTTP is not supported.
  • After unsubscribing, the subscription cannot be re-established using the same subscription ID. If a new subscription is needed, call slotSubscribe again.
  • If the WebSocket connection is closed, subscriptions are automatically cancelled, so subscriptions must be re-established upon reconnection.

1. Request

Parameters

The slot unsubscribe request has the following parameters.

ParameterTypeRequiredDescription
idinteger or stringrequiredUnique identifier for the request. Used by the client to match requests with responses.
jsonrpcstringrequiredJSON-RPC protocol version. Always set to "2.0".
methodstringrequiredName of the method to execute. Enter "slotUnsubscribe" here.
paramsarrayrequiredAn array containing the subscription ID of the subscription to cancel.

Example

{
"jsonrpc": "2.0",
"id": 1,
"method": "slotUnsubscribe",
"params": [0]
}

2. Response

Success Response

When the subscription is successfully cancelled, true is returned.

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

Error Response

If the unsubscribe fails, an error is returned.

{
"jsonrpc": "2.0",
"error": {
"code": -32000,
"message": "Invalid subscription ID"
},
"id": 1
}

3. How to Use

Connect to WebSocket Channel

wscat -c wss://api.mainnet-beta.solana.com

Subscribe to Slots (First)

{
"jsonrpc": "2.0",
"id": 1,
"method": "slotSubscribe",
"params": []
}

Receive Subscription ID

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

Unsubscribe

There are two ways to unsubscribe:

  1. Close the connection: Press Ctrl+C in the terminal window to terminate the WebSocket connection, which automatically cancels all subscriptions.

  2. Cancel a specific subscription: Use slotUnsubscribe to cancel only a specific subscription while keeping the connection open.

{
"jsonrpc": "2.0",
"id": 2,
"method": "slotUnsubscribe",
"params": [0]
}

Confirm Unsubscribe

{
"jsonrpc": "2.0",
"result": true,
"id": 2
}