---
api: 'Revolut X Crypto Exchange REST API'
---

# Get order book snapshot

Retrieve the current order book snapshot (bids and asks) for a specific trading pair.

## Endpoint

GET `/order-book/{symbol}`

## Parameters

### header parameters

- `X-Revx-Timestamp` (integer, required)
  Current timestamp in Unix epoch milliseconds. 
  Used to prevent replay attacks and construct the signature.
  Provided with other authentication headers.

- `X-Revx-Signature` (string, required)
  The Ed25519 signature of the request. 
  Provided with other authentication headers.
  
  :::tip
  See **Authentication headers: Signing a request** for details on how to generate this.
  :::

### path parameters

- `symbol` (string, required)
  The trading pair symbol (e.g., BTC-USD).

### query parameters

- `limit` (integer, optional)
  Depth of the order book to return (number of levels).

## Returns

### 200

OK

The Order Book snapshot for the given trading pair.

#### Response attributes

- `data` (object)
  - `data.asks` (array of object)
      The list of asks (sell orders), sorted by price in descending order.
    - `data.asks[].aid` (string)
        Crypto-asset ID code.
    - `data.asks[].anm` (string)
        Crypto-asset full name.
    - `data.asks[].s` (enum)
        The side of the price level.
        Possible enum values:

        - `SELL`
        - `BUYI`
    - `data.asks[].p` (string)
        Price in major currency units. For example, for USD, 4600 represents 4600 dollars.
    - `data.asks[].pc` (string)
        Price currency.
    - `data.asks[].pn` (string)
        Price notation.
    - `data.asks[].q` (string)
        Aggregated quantity at this price level.
    - `data.asks[].qc` (string)
        Quantity currency.
    - `data.asks[].qn` (string)
        Quantity notation.
    - `data.asks[].ve` (string)
        Venue of execution. Always equals `REVX`.
    - `data.asks[].no` (string)
        Number of orders at the price level.
    - `data.asks[].ts` (string)
        Trading system. Always equals `CLOB` (Central Limit Order Book).
    - `data.asks[].pdt` (integer)
        Publication date and time, returned in Unix epoch milliseconds
  - `data.bids` (array of object)
      The list of bids (buy orders), sorted by price in descending order.
    - `data.bids[].aid` (string)
        Crypto-asset ID code.
    - `data.bids[].anm` (string)
        Crypto-asset full name.
    - `data.bids[].s` (enum)
        The side of the price level.
        Possible enum values:

        - `SELL`
        - `BUYI`
    - `data.bids[].p` (string)
        Price in major currency units. For example, for USD, 4600 represents 4600 dollars.
    - `data.bids[].pc` (string)
        Price currency.
    - `data.bids[].pn` (string)
        Price notation.
    - `data.bids[].q` (string)
        Aggregated quantity at this price level.
    - `data.bids[].qc` (string)
        Quantity currency.
    - `data.bids[].qn` (string)
        Quantity notation.
    - `data.bids[].ve` (string)
        Venue of execution. Always equals `REVX`.
    - `data.bids[].no` (string)
        Number of orders at the price level.
    - `data.bids[].ts` (string)
        Trading system. Always equals `CLOB` (Central Limit Order Book).
    - `data.bids[].pdt` (integer)
        Publication date and time, returned in Unix epoch milliseconds
- `metadata` (object)
  - `metadata.timestamp` (integer)
      Timestamp when the order book snapshot was generated, returned in Unix epoch milliseconds.

## Error responses

| HTTP status code | Description |
| --- | --- |
| 400 | Bad request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 409 | Conflict |
| 429 | Rate Limit Exceeded |
| 5XX | Server Error |