Get order book

REQUEST wss://ws-mdpro.bitvavo.com/v2 getBook

Returns the list of up to 1000 bids and asks per request for the specified market, sorted by price.

Rate limit weight points: 1

Request

Schema

Body

actionstring
Set value to getBook.
Example: getBook
requestIdinteger
Your identifier for the request.
Example: 1
marketstringrequired
The market for which to return the order book.
Example: BTC-EUR
depthinteger
The number of bids and asks to return.
Possible values: >= 1 and <= 1000
Example: 4

Example (body)

{
  "action": "getBook",
  "requestId": 1,
  "market": "BTC-EUR",
  "depth": 4
}

Response

Schema

Schema

actionstring
The action performed.
Example: getBook
requestIdinteger
Your identifier for the request.
Example: 1
response object
marketstring
The market for which the order book is returned.
Example: BTC-EUR
nonceintegerdeprecated
Unique identifier of the market data snapshot. Increments by 1 with each order book update.


WS Market Data Pro nonce values cannot be used with standard WebSocket or REST APIs.
Example: 3
bidsarray[]
The list of buy orders for the specified market and depth. Every bid contains:
• price: the offer for 1 unit of base currency in the amount of quote currency. For example, 34243 Euros.

• size: the amount of base currency in the offer. For example, 0.1 Bitcoin.
Example: [["4999.9","0.015"],["4999.8","0.015"]]
asksarray[]
The list of sell orders for the specified market and depth. Every bid contains:
• price: the offer for 1 unit of base currency in the amount of quote currency. For example, 34243 Euros.

• size: the amount of base currency in the offer. For example, 0.1 Bitcoin.
Example: [["5001.1","0.015"],["5001.2","0.015"]]
timestampinteger
The Unix timestamp in nanoseconds of the last transaction event.
Example: 1542967486256
mdSeqNointeger
The sequence number of the requested order book snapshot in our system.
Example: 438524

Example (body)

{
  "action": "getBook",
  "requestId": 1,
  "response": {
    "market": "BTC-EUR",
    "nonce": 3,
    "bids": [
      [
        "4999.9",
        "0.015"
      ],
      [
        "4999.8",
        "0.015"
      ]
    ],
    "asks": [
      [
        "5001.1",
        "0.015"
      ],
      [
        "5001.2",
        "0.015"
      ]
    ],
    "timestamp": 1542967486256,
    "mdSeqNo": 438524
  }
}