PUBLISH Get Open Orders

PUB wss://test-api.synquote.com/ws

Returns a list of open orders for an account.

REQUEST

HEADER PARAMS
msg_type string required
Message type: get_orders
id number required
The ID of the request. This is returned in the response header.
version integer required
Version number: 1
BODY PARAMS
account_id string required
The account for which to get open orders.
instrument_id string
The instrument for which to receive open orders.
order_id string
The order ID for which to receive open orders.
client_order_id string
The client order ID for which to receive open orders.
Example
[
  {
    "msg_type":"get_orders",
    "id": 1002,
    "version": 1
  },
  {
    "account_id": "0x9f58498b98348b9BFbE53F0E18AA818a4Be0aE49",
    "instrument_id": "ETH-PERPETUAL"
  }
]

RESPONSE

array of objects
object
account_id string
The account address which placed the order.
transaction_ts string
The time the order was received by the system in UNIX epoch nanoseconds.
client_order_id string
The client-assigned order ID. Set automatically to order_id if absent.
execution_type string
The execution type of the order. Can be post_only or allow_cross.
expiration string
The expiration time of the order in UNIX epoch seconds.
initial_size string
The initial size of the order.
instrument_id string
The instrument of the order.
limit_price string
The limit price of the order.
nonce string
Used to make orders with otherwise identical signed fields unique.
order_id string
The unique ID of the order.
order_type string
The order type of the order. Can be limit, market, take_profit, or stop.
remaining_size string
The remaining unfilled portion of the order.
side string
The side of the order.
signature string
Signed order fields which are submitted to smart contracts for processing.
time_in_force string
The time in force of the order. Can be gtc, gte, ioc, or fok.
reduce_only string
Whether the order is reduce only.
trigger_price string
The trigger price of the order. Only present for take_profit and stop orders.
prev_order_type string
The original order type before it was triggered into a new state. This field will differ from order_type if the order transitioned to a different type upon triggering a condition (e.g., a stop order converting to a market order). If no such transition occurred, this field will match order_type.
Example
[
  {
    "msg_type":"get_orders_response",
    "id": 1002,
    "version": 1
  },
  [
    {
      "account_id": "0x9f58498b98348b9bfbe53f0e18aa818a4be0ae49",
      "transaction_ts": "1714612305576158821",
      "client_order_id": "11145708517292646282",
      "execution_type": "allow_cross",
      "expiration": "1723252305",
      "initial_size": "10",
      "instrument_id": "ETH-PERPETUAL",
      "limit_price": "2920",
      "nonce": "1714612305478",
      "order_id": "11145708517292646282",
      "order_type": "limit",
      "remaining_size": "10",
      "side": "buy",
      "signature": "0xba06176617f104fc21028b897d0455a4cb637510b6048dc4c0bbe1cd72a675b8374fe56b2c3f0ae3b2d28c809be6d466b57bb8c273e44d4c61a67c18112aefc61b",
      "time_in_force": "gtc",
      "reduce_only": false,
      "prev_order_type": "limit"
    }
  ]
]