accountUnsubscribe

accountUnsubscribe WebSocket Method

post
/

Unsubscribe from account change notifications. This method cancels an existing account subscription identified by the subscription ID that was returned from a previous accountSubscribe call. Once unsubscribed, you will no longer receive accountNotification messages for the specified subscription.

Authorizations
AuthorizationstringOptional

Authorization header for API key authentication.

Example:

Authorization: your-api-key-here
Body

Request object for unsubscribing from account 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: accountUnsubscribePossible values:
paramsinteger[] · min: 1 · max: 1Required

Method parameters array containing the subscription ID to cancel

Example: [23784]
Responses
chevron-right
200

Unsubscription successful

application/json

Response indicating the success or failure of the 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 subscription was successfully cancelled, false otherwise. A successful unsubscribe means you will no longer receive notifications for that subscription.

Example: true
post
/

Last updated