JSON-RPCoverWebSockets

Authentication + Subscribe & Unsubscribe to Notification Channels

1. Authenticate, establish a heartbeat and Subscribe to the rfq, quote_status, quote_book, quote, order, trade, and trade_tape JSON-RPCoverWebSockets Notification Channels.

Message Sequence Numbers

WebSocket messages contain sequence numbers to help clients identify if they have missed any messages during temporary disconnections or network errors. The sequence number is included in the WebSocket messages under the meta field.

Message Structure with Sequence Numbers

WebSocket messages now include an additional meta field that contains the following properties:

Here’s an example of a WebSocket message with sequence numbers:

1
{
2
  "jsonrpc": "2.0",
3
  "method": "subscription",
4
  "params": {
5
    "channel": "rfq",
6
    "data": {
7
    },
8
    "meta": {
9
      "seq_group": 1692463499,
10
      "seq_num": 1027
11
    }
12
  }
13
}

Handling Sequence Numbers

Clients should monitor the sequence numbers of the incoming messages to ensure they have not missed any messages. If a client detects a gap in the sequence numbers, it may have missed one or more messages and should take appropriate action, such as refreshing data from REST.

Sequences increase monotonically within the context of a sequence group. Sequences are only relevant within a sequence group, which represents a subscribed channel. Sequences may be re-used between sequence groups.

While messages are sent ordered according to their sequences, sequences are not guaranteed not to repeat.