For the complete documentation index, see llms.txt. This page is also available as Markdown.

SUBSCRIBE Book Ticker

UPDATE TIME

Real Time

REQUEST

<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>
  </th>
</tr>

* \*op\*\* string required Operation code allowed values: `subscribe` `unsubscribe`

  • ASSET allowed values: ETH & BTC

  • INSTRUMENT_TYPE allowed values : OPTION PERPETUAL

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

RESPONSE

<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>
  </th>
</tr>

* \*channel\*\* string required Channel name in the format `ticker:ASSET:INSTRUMENT_TYPE` or `ticker:INSTRUMENT_NAME`. Eg. `ticker:ETH:OPTION` or `ticker:ETH-31MAR23-1350-C`.

Last updated