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

SUBSCRIBE Orders

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: `orders`
  </td>
</tr>
  </th>
</tr>

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

Example
{
	"op":"subscribe", 
	"data": ["orders"]
}

RESPONSE

    </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: orders
</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>orders <span class="ws-data-type ws-small-font">array of objects</span> <span class="ws-required-tag ws-small-font">required</span>
Order updates in Order object format.
  &#x3C;div style={{ height: "10px" }}>&#x3C;/div>  &#x3C;table>    &#x3C;tr>      &#x3C;td class="child-header">**ORDER OBJECT**&#x3C;/td>    &#x3C;/tr>    &#x3C;tr>      &#x3C;td>**order_id** &#x3C;span class="ws-data-type ws-small-font">string&#x3C;/span> &#x3C;span class="ws-required-tag ws-small-font">required&#x3C;/span>        Order ID. Eg. `0x4c43e0ab72a4edb72dfe4b129148899815d816837b9a7e22d964b884834639f8`&#x3C;/td>    &#x3C;/tr>    &#x3C;tr>      &#x3C;td>**account** &#x3C;span class="ws-data-type ws-small-font">string&#x3C;/span> &#x3C;span class="ws-required-tag ws-small-font">required&#x3C;/span>        Account's Ethereum address. Eg. `0xE9b3a48d15BE316A8e34FAd53fFDFDddf0C3D24b`&#x3C;/td>    &#x3C;/tr>    &#x3C;tr>      &#x3C;td>**instrument_id** &#x3C;span class="ws-data-type ws-small-font">string&#x3C;/span> &#x3C;span class="ws-required-tag ws-small-font">required&#x3C;/span>        Instrument ID number. Eg. `12` &#x3C;/td>    &#x3C;/tr>    &#x3C;tr>      &#x3C;td>**instrument_name** &#x3C;span class="ws-data-type ws-small-font">string&#x3C;/span> &#x3C;span class="ws-required-tag ws-small-font">required&#x3C;/span>        Instrument name. Eg. `ETH-24DEC22-1250-C`&#x3C;/td>    &#x3C;/tr>    &#x3C;tr>      &#x3C;td>**instrument_type** &#x3C;span class="ws-data-type ws-small-font">string&#x3C;/span> &#x3C;span class="ws-required-tag ws-small-font">required&#x3C;/span>        Type of instrument. Allowed values: `OPTION` `PERPETUAL`&#x3C;/td>    &#x3C;/tr>    &#x3C;tr>      &#x3C;td>**order_type** &#x3C;span class="ws-data-type ws-small-font">string&#x3C;/span> &#x3C;span class="ws-required-tag ws-small-font">required&#x3C;/span>        Order type. Allowed values: `limit` `market`&#x3C;/td>    &#x3C;/tr>    &#x3C;tr>      &#x3C;td>**side** &#x3C;span class="ws-data-type ws-small-font">string&#x3C;/span> &#x3C;span class="ws-required-tag ws-small-font">required&#x3C;/span>        Trade side. Allowed values: `buy` `sell`&#x3C;/td>    &#x3C;/tr>    &#x3C;tr>      &#x3C;td>**price** &#x3C;span class="ws-data-type ws-small-font">string&#x3C;/span> &#x3C;span class="ws-required-tag ws-small-font">required&#x3C;/span>        Price in USD. Eg. `12.23`&#x3C;/td>    &#x3C;/tr>    &#x3C;tr>      &#x3C;td>**amount** &#x3C;span class="ws-data-type ws-small-font">string&#x3C;/span> &#x3C;span class="ws-required-tag ws-small-font">required&#x3C;/span>        Amount of contracts. Eg. `12.23`&#x3C;/td>    &#x3C;/tr>    &#x3C;tr>      &#x3C;td>**filled** &#x3C;span class="ws-data-type ws-small-font">string&#x3C;/span> &#x3C;span class="ws-required-tag ws-small-font">required&#x3C;/span>        Amount filled. Eg. `10.4`&#x3C;/td>    &#x3C;/tr>    &#x3C;tr>      &#x3C;td>**order_status** &#x3C;span class="ws-data-type ws-small-font">string&#x3C;/span> &#x3C;span class="ws-required-tag ws-small-font">required&#x3C;/span>        Order status. Allowed values: `opened` `cancelled` `partial` `filled`&#x3C;/td>    &#x3C;/tr>    &#x3C;tr>      &#x3C;td>**created_timestamp** &#x3C;span class="ws-data-type ws-small-font">string&#x3C;/span> &#x3C;span class="ws-required-tag ws-small-font">required&#x3C;/span>        Created timestamp in UNIX timestamp in nanoseconds. Eg. `1680249600000000000`&#x3C;/td>    &#x3C;/tr>    &#x3C;tr>      &#x3C;td>**system_type** &#x3C;span class="ws-data-type ws-small-font">string&#x3C;/span> &#x3C;span class="ws-required-tag ws-small-font">required&#x3C;/span>        Order's system type. Eg. `WEB` or `API`&#x3C;/td>    &#x3C;/tr>  &#x3C;/table>&#x3C;/td>
</tr>
</tbody>

Last updated