Skip to main content

subscribe RPC Method

Requests periodic notifications from the server when certain events happen

Updated on
Oct 4, 2023

subscribe RPC Method

Parameters

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 \
2
# wait for connection
3
{"command":"subscribe","id": "Example watch Bitstamp's hot wallet","accounts": ["rrpNnNLKrartuEqfJGpqyDwPj1AFPg9vn1"]}
Don't have an account yet?
Create your QuickNode endpoint in seconds and start building
Get started for free