Book

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

[
  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"
      ]
    ]
  },
  "book-100",
  "XBT/USD"
]

[
  1234,
  {
    "a": [
      [
        "5541.30000",
        "2.50700000",
        "1534614248.456738"
      ],
      [
        "5542.50000",
        "0.40100000",
        "1534614248.456738"
      ]
    ],
    "c": "974942666"
  },
  "book-10",
  "XBT/USD"
]

[
  1234,
  {
    "b": [
      [
        "5541.30000",
        "0.00000000",
        "1534614335.345903"
      ]
    ],
    "c": "974942666"
  },
  "book-10",
  "XBT/USD"
]

[
  1234,
  {
    "a": [
      [
        "5541.30000",
        "2.50700000",
        "1534614248.456738"
      ],
      [
        "5542.50000",
        "0.40100000",
        "1534614248.456738"
      ]
    ]
  },
  {
    "b": [
      [
        "5541.30000",
        "0.00000000",
        "1534614335.345903"
      ]
    ],
    "c": "974942666"
  },
  "book-10",
  "XBT/USD"
]

[
  1234,
  {
    "a": [
      [
        "5541.30000",
        "2.50700000",
        "1534614248.456738",
        "r"
      ],
      [
        "5542.50000",
        "0.40100000",
        "1534614248.456738",
        "r"
      ]
    ],
    "c": "974942666"
  },
  "book-25",
  "XBT/USD"
]

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

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

[
  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"
      ]
    ]
  },
  "book-100",
  "XBT/USD"
]

[
  1234,
  {
    "a": [
      [
        "5541.30000",
        "2.50700000",
        "1534614248.456738"
      ],
      [
        "5542.50000",
        "0.40100000",
        "1534614248.456738"
      ]
    ],
    "c": "974942666"
  },
  "book-10",
  "XBT/USD"
]

[
  1234,
  {
    "b": [
      [
        "5541.30000",
        "0.00000000",
        "1534614335.345903"
      ]
    ],
    "c": "974942666"
  },
  "book-10",
  "XBT/USD"
]

[
  1234,
  {
    "a": [
      [
        "5541.30000",
        "2.50700000",
        "1534614248.456738"
      ],
      [
        "5542.50000",
        "0.40100000",
        "1534614248.456738"
      ]
    ]
  },
  {
    "b": [
      [
        "5541.30000",
        "0.00000000",
        "1534614335.345903"
      ]
    ],
    "c": "974942666"
  },
  "book-10",
  "XBT/USD"
]

[
  1234,
  {
    "a": [
      [
        "5541.30000",
        "2.50700000",
        "1534614248.456738",
        "r"
      ],
      [
        "5542.50000",
        "0.40100000",
        "1534614248.456738",
        "r"
      ]
    ],
    "c": "974942666"
  },
  "book-25",
  "XBT/USD"
]

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

Order book levels. On subscription, a snapshot is published at the specified depth, followed by level updates. Subscription depth options are 10, 25, 100, 500, or 1000 levels per side.

Request
Response

string

required

Value: subscribe

string[]

required

Example: ["BTC/USD", "MATIC/GBP"]The currency pairs for this request.

object

Hide properties

string

required

Value: book

integer

One of: 10, 25, 100, 500, 1000
Default: 10Specifies the number of price levels (in each side of the book) to be received.

string

Optional client originated request identifier sent as acknowledgment in the response.

Snapshot

Note, there is no checksum on the snapshot.

array

Hide elements

integer

deprecated

Deprecated: use channelName and pairChannel identifier.

object

Show properties

array

Ask price levels, ascending from best ask.

Show elements

array

Show elements

string

The price of this level.

string

Price level volume, for updates volume = 0 for level removal/deletion.

string

Format: Epoch Seconds
Example: 1534614248.456738Timestamp when the level last updated.

array

Bid price levels, ascending from best bid.

Show elements

array

Show elements

string

Price level.

string

Price level volume, for updates volume = 0 for level removal/deletion.

string

Format: Epoch Seconds
Example: 1534614248.456738Timestamp when the level last updated.

string

Example: "BTC/USD"The symbol of the currency pair.

string

Value: book-[depth]

Update

array

Hide elements

integer

deprecated

Deprecated: use channelName and pairChannel identifier.

object

Show properties

array

Ask price levels.

Show elements

array

Show elements

string

The price for this level.

string

The cumulative volume at this price level. If volume is 0, remove level from book.

string

Format: Epoch Seconds
Example: 1534614248.456738Timestamp when the level was last updated.

string

One of: r
Condition: Republish only

string

Example: "4088505763"
Condition: Only present on last updateBook checksum as a quoted unsigned 32-bit integer.

array

Bid price levels.

Show elements

array

Show elements

string

The price for this level.

string

The cumulative volume at this price level. If volume is 0, remove level from book.

string

Format: Epoch Seconds
Example: 1534614248.456738Timestamp when the level was last updated.

string

One of: r
Condition: Republish only

string

Example: "4088505763"
Condition: Only present on last updateBook checksum as a quoted unsigned 32-bit integer.

string

Example: "BTC/USD"The symbol of the currency pair.

string

Value: book-[depth]

Unsubscribe

Request
Response

string

required

Value: unsubscribe

string[]

Example: ["BTC/USD", "MATIC/GBP"]
Condition: All channels which support pair subscriptionsThe currency pairs to unsubscribe.

string

Optional client originated request identifier sent as acknowledgment in the response.

object

Hide properties

string

required

Value: book

integer

Condition: ‘book’ channel onlyUnsubscribe to a specific depth.

⌘I

Public Channels

Trading

Account

System

Snapshot

Update

Unsubscribe

​Subscribe

​Snapshot

​Update

​Unsubscribe

Subscribe

Snapshot

Update

Unsubscribe