Parameters

object

object

REQUIRED

The subscribe request object.

streams

array

An array of string names of generic streams to subscribe to

accounts

array

An array with the unique addresses of accounts to monitor for validated transactions

accounts_proposed

array

It includes transactions that are not yet finalized

books

array

An array of objects defining order books to monitor for updates

url

string

URL where the server sends a JSON-RPC callbacks for each event. Admin-only

url_username

string

The username to provide for basic authentication at the callback URL

url_password

string

The password to provide for basic authentication at the callback URL

Returns

id

string

The unique identifier for the subscription request

status

string

The status of the subscription 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":"subscribe","params":[{"streams":[],"accounts":["rrpNnNLKrartuEqfJGpqyDwPj1AFPg9vn1"],"accounts_proposed":[],"books":[]}]}

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

Response

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

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

Don't have an account yet?

Create your Quicknode endpoint in seconds and start building

Get started for free