---
updatedAt: 2025-09-30T07:52:05.000Z
agentTools:
  projectIndex: https://api-docs.aevo.xyz/llms.txt
---

# SUBSCRIBE Book Ticker (NEW)

<div class="ws-method-div"><span class="APIMethod APIMethod_fixedWidth ws-sub-tag">SUB</span> <span class="ws-small-font">wss://ws.aevo.xyz</span></div><span class="ws-description">Returns instrument ticker information when its top of the book changes and returns information such as: instrument data, bid and asks</span>

<span class="ws-small-font">**UPDATE TIME**</span>

<span class="ws-data-type ws-small-font">**Real Time**</span>

<span class="ws-small-font">**REQUEST**</span>

<Table align={["left"]}>
  <thead>
    <tr>
      <th>

      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        * \*op\*\* <span class="ws-data-type ws-small-font">string</span>  <span class="ws-required-tag ws-small-font">required</span>
          Operation code allowed values: `subscribe` `unsubscribe`
      </td>
    </tr>

    <tr>
      <td>
        * \*data\*\* <span class="ws-data-type ws-small-font">array of strings</span>  <span class="ws-required-tag ws-small-font">required</span>\
          Channel name in the format `book-ticker:ASSET:INSTRUMENT_TYPE` or `book-ticker:INSTRUMENT_NAME`.\
          Eg. `book-ticker:ETH:OPTION` or `book-ticker:ETH-31MAR23-1350-C`.
      </td>
    </tr>
  </tbody>
</Table>

* `ASSET` allowed values: `ETH` & `BTC`
* `INSTRUMENT_TYPE` allowed values : `OPTION` `PERPETUAL`

<details/>
<summary>Example</summary>

```json
{
	"op":"subscribe", 
	"data": ["book-ticker:ETH-31MAR23-1350-C"]
}
```

```json
{
	"op":"subscribe", 
	"data": ["book-ticker:ETH:OPTION"]
}
```

<br />

<span class="ws-small-font">**RESPONSE**</span>

<Table align={["left"]}>
  <thead>
    <tr>
      <th>

      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        * \*channel\*\* <span class="ws-data-type ws-small-font">string</span>  <span class="ws-required-tag ws-small-font">required</span>
          Channel name in the format `ticker:ASSET:INSTRUMENT_TYPE` or `ticker:INSTRUMENT_NAME`.
          Eg. `ticker:ETH:OPTION` or `ticker:ETH-31MAR23-1350-C`.
      </td>
    </tr>

    <tr>
      <td>
        <span class="ws-small-font">data.</span>**timestamp** <span class="ws-data-type ws-small-font">string</span> <span class="ws-required-tag ws-small-font">required</span>\
        Update timestamp in UNIX timestamp in nanoseconds. Eg. `1680249600000000000`
      </td>
    </tr>

    <tr>
      <td>
        <span class="ws-small-font">data.</span>**tickers** <span class="ws-data-type ws-small-font">array of objects</span> <span class="ws-required-tag ws-small-font">required</span>\
        Ticker information.  

        <div style={{ height: "10px" }}></div>
        <table>
          <tr>
            <td class="child-header">**TICKER OBJECT**</td>
          </tr>
          <tr>
            <td>**instrument_id** <span class="ws-data-type ws-small-font">string</span> <span class="ws-required-tag ws-small-font">required</span>
            Instrument ID number. Eg. `12`</td>
          </tr>
          <tr>
            <td>**instrument_name** <span class="ws-data-type ws-small-font">string</span> <span class="ws-required-tag ws-small-font">required</span>
            Instrument name. Eg.` ETH-24DEC22-1250-C`</td>
          </tr>
          <tr>
            <td>**instrument_type** <span class="ws-data-type ws-small-font">string</span> <span class="ws-required-tag ws-small-font">required</span>
            Type of instrument. Allowed values: `OPTION` `PERPETUAL`</td>
          </tr>
          <tr>
            <td>
              **bid** <span class="ws-data-type ws-small-font">object</span> <span class="ws-required-tag ws-small-font">required</span>
              <br />
              Top bid details in `ticker` object format.
              <div style={{ height: "10px" }}></div>
              <table>
                <tr>
                  <td class="child-header">**PRICE LEVEL OBJECT**</td>
                </tr>
              </table>
            </td>
          </tr>
          <tr>
            <td>
              **ask** <span class="ws-data-type ws-small-font">object</span> <span class="ws-required-tag ws-small-font">required</span>
              <br />
              Top ask details in `ticker` object format.
              <div style={{ height: "10px" }}></div>
              <table>
                <tr>
                  <td class="child-header">**PRICE LEVEL OBJECT**</td>
                </tr>
              </table>
            </td>
          </tr>
        </table>
      </td>
    </tr>
  </tbody>
</Table>

<details/>
<summary>Example</summary>

```json
{
    "channel": "book-ticker:ETH-31MAR23-1350-C",
    "data": {
        "timestamp": "1673436965238291661",
        "tickers": [
            {
                "instrument_id": 165,
                "instrument_name": "ETH-31MAR23-1350-C",
                "instrument_type": "OPTION",
                "bid": {
                    "price": "2",
                    "delta": "0.2159147503564693",
                    "theta": "-0.03033364841496897",
                    "gamma": "0.017935537671398397",
                    "rho": "0.6193026765188775",
                    "vega": "2.466304065911212",
                    "iv": "0.026280592178461275",
                    "amount": "10"
                },
                "ask": {
                    "price": "10",
                    "delta": "0.3756922766741976",
                    "theta": "-0.09391922572782523",
                    "gamma": "0.009719490995099413",
                    "rho": "1.063503444637495",
                    "vega": "2.466304065911212",
                    "iv": "0.06281820373274899",
                    "amount": "1"
                }
            }
        ]
    }
}
```