Honeycluster Docs – Unsubscribe from event streams

Subscription Methods

Unsubscribe from event streams

wss://honeycluster.io

rpc method: unsubscribe

Unsubscribes from previously subscribed event streams.

Try it now

Response · unsubscribe WS Response

{
  "result": {},
  "status": "success",
  "type": "response",
  "id": 1
}

Request Message

unsubscribe WS Request

application/json

Unsubscribe from event streams

Field	Type	Description
`command` required	string	WebSocket command name
`id`	object	Client-supplied identifier to correlate requests with responses.
`streams`	enum<string>[]	Array of stream types to unsubscribe from.
`accounts`	string[]	Array of account addresses to unsubscribe from.
`accounts_proposed`	string[]	Array of proposed-transaction accounts to unsubscribe from.
`books`	object[]	Array of order book subscriptions to cancel.
`books[].taker_gets` required	object	Currency specification object identifying a token or XRP.
`books[].taker_gets.currency` required	string	Three-letter ISO 4217 currency code, or 160-bit hex currency code.
`books[].taker_gets.issuer`	string	Account address of the token issuer. Omit for XRP.
`books[].taker_pays` required	object	Currency specification object identifying a token or XRP.
`books[].taker_pays.currency` required	string	Three-letter ISO 4217 currency code, or 160-bit hex currency code.
`books[].taker_pays.issuer`	string	Account address of the token issuer. Omit for XRP.
`books[].both`	boolean
`api_version`	object	API version for the response format. Version 2 is the default for rippled 2.0+.

Example

Json

{
  "command": "unsubscribe",
  "id": 1,
  "streams": [
    "ledger",
    "transactions"
  ],
  "accounts": [
    "rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn"
  ]
}

Response Message

unsubscribe WS Response

application/json

WebSocket response for unsubscribe

Field	Type	Description
`result`	object
`status`	enum<string>	Available `successerror`
`type`	string
`id`	stringnumber	Echo of the client-provided correlation ID

Example

Json

{
  "result": {},
  "status": "success",
  "type": "response",
  "id": 1
}

Request

Payload · JSON

const ws = new WebSocket('wss://honeycluster.io');

ws.addEventListener('open', () => {
  const request = {
    "command": "unsubscribe",
    "id": 1,
    "streams": [
      "ledger",
      "transactions"
    ],
    "accounts": [
      "rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn"
    ]
  };
  ws.send(JSON.stringify(request));
});

ws.addEventListener('message', (event: MessageEvent<string>) => {
  const response: unknown = JSON.parse(event.data);
  console.log(response);
  ws.close();
});

Response · unsubscribe WS Response

{
  "result": {},
  "status": "success",
  "type": "response",
  "id": 1
}