ping

Request: Client can ping server to determine whether connection is alive, server responds with pong. This is an application level ping as opposed to default ping in WebSockets standard which is server initiated

Payload

Example of payload

{
  "event": "ping",
  "reqid": 42
}

pong

Response: Server pong response to a ping to determine whether connection is alive. This is an application level pong as opposed to default pong in WebSockets standard which is sent by client in response to a ping

Payload

Example of payload

{
  "event": "pong",
  "reqid": 42
}

heartbeat

Publication: Server heartbeat sent if no subscription traffic within 1 second (approximately)

Payload

Example of payload

{
  "event": "heartbeat"
}

systemStatus

Publication: Status sent on connection or system status changes.

Payload

Example of payload

{
  "connectionID":8628615390848610222,
  "event": "systemStatus",
  "status": "online",
  "version": "1.0.0"
}

subscribe

Request: Subscribe to a topic on a single or multiple currency pairs.

Payload

Examples of payload

{
  "event": "subscribe",
  "pair": [
    "XBT/USD","XBT/EUR"
  ],
  "subscription": {
    "name": "ticker"
  }
}

{
  "event": "subscribe",
  "pair": [
    "XBT/EUR"
  ],
  "subscription": {
    "name": "ohlc",
    "interval": 5
  }
}

unsubscribe

Request: Unsubscribe from single subscription, can specify multiple currency pairs.

Payload

Examples of payload

{
  "event": "unsubscribe",
  "pair": [
    "XBT/EUR","XBT/USD"
  ],
  "subscription": {
    "name": "ticker"
  }
}

{
  "event": "unsubscribe",
  "channelID": 10001
}

subscriptionStatus

Response & Publication: Subscription status response to subscribe, unsubscribe or exchange initiated unsubscribe.

Payload

Examples of payload

{
  "channelID": 10001,
  "event": "subscriptionStatus",
  "status": "subscribed",
  "pair": "XBT/EUR",
  "subscription": {
    "name": "ticker"
  }

}

{
  "channelID": 10001,
  "event": "subscriptionStatus",
  "status": "unsubscribed",
  "pair": "XBT/EUR",
  "reqID": 42,
  "subscription": {
    "name": "ohlc",
    "interval": 5
  }
}

{
  "errorMessage": "Subscription depth not supported",
  "event": "subscriptionStatus",
  "pair": "XBT/USD",
  "status": "error",
  "subscription": {
    "name": "book",
    "depth":42
  }
}

ticker

Publication: Ticker information includes best ask and best bid prices, 24hr volume, last trade price, volume weighted average price, etc for a given currency pair. A ticker message is published every time a trade or a group of trade happens.

Payload

Example of payload

[
  0,
  {
    "a": [
      "5525.40000",
      1,
      "1.000"
    ],
    "b": [
      "5525.10000",
      1,
      "1.000"
    ],
    "c": [
      "5525.10000",
      "0.00398963"
    ],
    "v": [
      "2634.11501494",
      "3591.17907851"
    ],
    "p": [
      "5631.44067",
      "5653.78939"
    ],
    "t": [
      11493,
      16267
    ],
    "l": [
      "5505.00000",
      "5505.00000"
    ],
    "h": [
      "5783.00000",
      "5783.00000"
    ],
    "o": [
      "5760.70000",
      "5763.40000"
    ]
  }
]

ohlc

Publication: Open High Low Close (Candle) feed for a currency pair and interval period.

Description: When subscribed for OHLC, a snapshot of the last valid candle (irrespective of the endtime) will be sent, followed by updates to the running candle. For example, if a subscription is made to 1 min candle and there have been no trades for 5 mins, a snapshot of the last 1 min candle from 5 mins ago will be published. The endtime can be used to determine that it is an old candle.

Payload

Example of payload

[
  42,
  [
    "1542057314.748456",
    "1542057360.435743",
    "3586.70000",
    "3586.70000",
    "3586.60000",
    "3586.60000",
    "3586.68894",
    "0.03373000",
    2
  ]
]

trade

Publication: Trade feed for a currency pair.

Payload

Example of payload

[
  0,
  [
    [
      "5541.20000",
      "0.15850568",
      "1534614057.321597",
      "s",
      "l",
      ""
    ],
    [
      "6060.00000",
      "0.02455000",
      "1534614057.324998",
      "b",
      "l",
      ""
    ]
  ]
]

spread

Publication: Spread feed to show best bid and ask price for a currency pair

Payload

Example of payload

[
  0,
  [
    "5698.40000",
    "5700.00000",
    "1542057299.545897"
  ]
]

book

Publication: Order book levels. On subscription, a snapshot will be published at the specified depth, following the snapshot, level updates will be published.

Snapshot Payload

Example of snapshot payload

[
  0,
  {
    "as": [
      [
          "5541.30000",
          "2.50700000",
          "1534614248.123678"
      ],
      [
          "5541.80000",
          "0.33000000",
          "1534614098.345543"
      ],
      [
          "5542.70000",
          "0.64700000",
          "1534614244.654432"
      ]
    ],
    "bs": [
      [
          "5541.20000",
          "1.52900000",
          "1534614248.765567"
      ],
      [
          "5539.90000",
          "0.30000000",
          "1534614241.769870"
      ],
      [
          "5539.50000",
          "5.00000000",
          "1534613831.243486"
      ]
    ]
  }
]