Subscribes/Unsubscribes to market order book event data. Events can either be per pair or general exchange level.


Important Update: WebSocket Endpoint Migration

We are excited to announce an upgrade to our WebSocket service! To ensure that our users enjoy enhanced reliability and performance, we have migrated our WebSocket endpoint. Please update your applications to connect to the new endpoint as described here:

  • Old Endpoint: wss://
  • New Endpoint: wss://

Action Required

Users are required to update the endpoint URL in their applications. The good news is that the response JSON schemas remain unchanged, so you can expect a seamless transition with minimal adjustments needed on your end.


We understand that changes like these can raise questions. Our support team is here to assist with any issues or concerns you may have during this migration process. Please don’t hesitate to contact us for support at: [email protected].

We appreciate your prompt action to migrate to the new WebSocket endpoint.

Once you're connected to this subscription: wss://, you must provide either the instrument or exchange - one needs to be specified, both cannot be empty.


All exchanges:


Specific exchange:

pair*stringThe asset pair.
exchangestringThe exchange for which to retrieve asset pairs.


Note: Subscription response will include a field metadata which includes the names of the columns in the order in which they appeared in the event notification response.


    "jsonrpc": "2.0",
    "method": "subscription",
    "params": {
        "subscription": "0f46d7af-3c49-4f2d-8e20-711efb9dc49a",
        "result": [
exchangestringThe exchange name.
pairstringThe pair name.
timestampnumberThe time at which the order book event took place.
timestampNanosecondsnumberThe nano second part of the timestampMilliseconds, where applicable.
pricenumberThe quote price of the asset pair.
volumenumberThe number of assets traded in a specific asset pair within a given period of time.
isBidboolIndicates if it is a bid or ask order: true for a bid and false for an ask.
sequencenumberA unique identifier for the order book event.


const WebSocket = require('ws');
const ws = new WebSocket('wss://', {headers: {'x-api-key':'<api_key>'}});

ws.on('open', () => {
      jsonrpc: '2.0',
      method: 'subscribe',
      params: ["market:spot:order:events",  {"pair": "btc_usd", "exchange": "gdax"}],
      id: 1,

ws.on('message', data => {
  console.log(JSON.stringify(JSON.parse(data), null, 2));