Parameters

object

object

REQUIRED

The unsubscribe request object.

streams

array

An array of string names of generic streams to unsubscribe from, including ledger, server, transactions, and transactions_proposed

accounts

array

Array of unique account addresses to stop receiving updates for, in the XRP Ledger's base58 format

accounts_proposed

array

Like accounts, but for accounts_proposed subscriptions that included not-yet-validated transactions

books

array

An array of objects defining order books to unsubscribe from

Returns

id

string

The unique identifier for the unsubscription request

status

string

The status of the unsubscription request

type

string

The type of response being received

result

string

The actual response data returned by the API

warnings

array

A list of warnings

id

integer

The ID of the warning

message

string

The warning message

Request

1
wscat -c wss://docs-demo.xrp-mainnet.quiknode.pro/ \
2
# wait for connection
3
{"id":1,"jsonrpc":"2.0","method":"unsubscribe","params":[{"streams":["ledger","server","transactions","transactions_proposed"],"accounts":["rrpNnNLKrartuEqfJGpqyDwPj1AFPg9vn1"],"accounts_proposed":["rrpNnNLKrartuEqfJGpqyDwPj1AFPg9vn1"],"books":[]}]}

1
wscat -c wss://docs-demo.xrp-mainnet.quiknode.pro/ \
2
# wait for connection
3
{"id":1,"jsonrpc":"2.0","method":"unsubscribe","params":[{"streams":["ledger","server","transactions","transactions_proposed"],"accounts":["rrpNnNLKrartuEqfJGpqyDwPj1AFPg9vn1"],"accounts_proposed":["rrpNnNLKrartuEqfJGpqyDwPj1AFPg9vn1"],"books":[]}]}

Response

1
{
2
  "id": 1,
3
  "jsonrpc": "2.0",
4
  "result": true
5
}

1
{
2
  "id": 1,
3
  "jsonrpc": "2.0",
4
  "result": true
5
}

Don't have an account yet?

Create your Quicknode endpoint in seconds and start building

Get started for free