Open Orders – Cryptocurrency Guide - Crypto Facilities

This endpoint returns information on all open orders for all Futures contracts.

Authentication is required.

Endpoint	Request Type	Permissible API Keys
/api/v3/openorders	GET	Read-only, Read-write, Master

Arguments
none

Sample Call

https://www.cryptofacilities.com/derivatives/api/v3/openorders

Sample Return if Successful

{
   "result":"success",
   "openOrders":[
      {
         "order_id":"59302619-41d2-4f0b-941f-7e7914760ad3",
         "symbol":"pi_xbtusd",
         "side":"sell",
         "orderType":"lmt",
         "limitPrice":10640,
         "unfilledSize":304,
         "receivedTime":"2019-09-05T17:01:17.410Z",
         "status":"untouched",
         "filledSize":0,
         "reduceOnly":true,
         "lastUpdateTime":"2019-09-05T17:01:17.410Z"
      },
      {
         "order_id":"022774bc-2c4a-4f26-9317-436c8d85746d",
         "symbol":"pi_xbtusd",
         "side":"buy",
         "orderType":"lmt",
         "limitPrice":7200,
         "unfilledSize":1501,
         "receivedTime":"2019-09-05T16:41:35.173Z",
         "status":"untouched",
         "filledSize":0,
         "reduceOnly":false,
         "lastUpdateTime":"2019-09-05T16:47:47.519Z"
      },
      {
         "order_id":"d08021f7-58cb-4f2c-9c86-da4c60de46bb",
         "symbol":"pi_xbtusd",
         "side":"sell",
         "orderType":"lmt",
         "limitPrice":10640,
         "unfilledSize":10000,
         "receivedTime":"2019-09-05T16:38:43.651Z",
         "status":"untouched",
         "filledSize":0,
         "reduceOnly":true,
         "lastUpdateTime":"2019-09-05T16:38:43.651Z"
      },
      {
         "order_id":"179f9af8-e45e-469d-b3e9-2fd4675cb7d0",
         "symbol":"pi_xbtusd",
         "side":"buy",
         "orderType":"lmt",
         "limitPrice":9400,
         "unfilledSize":10000,
         "receivedTime":"2019-09-05T16:33:50.734Z",
         "status":"untouched",
         "filledSize":0,
         "reduceOnly":false,
         "lastUpdateTime":"2019-09-05T16:33:50.734Z"
      },
      {
         "order_id":"9c2cbcc8-14f6-42fe-a020-6e395babafd1",
         "symbol":"pi_xbtusd",
         "side":"buy",
         "orderType":"lmt",
         "limitPrice":9400,
         "unfilledSize":1000,
         "receivedTime":"2019-09-04T11:45:48.884Z",
         "status":"untouched",
         "filledSize":0,
         "reduceOnly":false,
         "lastUpdateTime":"2019-09-05T16:41:40.996Z"
      },
      {
         "order_id":"3deea5c8-0274-4d33-988c-9e5a3895ccf8",
         "symbol":"pi_xbtusd",
         "side":"buy",
         "orderType":"lmt",
         "limitPrice":8500,
         "unfilledSize":102,
         "receivedTime":"2019-09-03T12:52:17.945Z",
         "status":"untouched",
         "filledSize":0,
         "reduceOnly":false,
         "lastUpdateTime":"2019-09-03T12:52:17.945Z"
      },
      {
         "order_id":"fcbb1459-6ed2-4b3c-a58c-67c4df7412cf",
         "symbol":"pi_xbtusd",
         "side":"buy",
         "orderType":"lmt",
         "limitPrice":7200,
         "unfilledSize":1501,
         "receivedTime":"2019-09-02T12:54:34.347Z",
         "status":"untouched",
         "filledSize":0,
         "reduceOnly":false,
         "lastUpdateTime":"2019-09-02T12:54:34.347Z"
      }
   ],
   "serverTime":"2019-09-05T17:08:18.138Z"
}

Field	Type	Description
result	String	Always success
serverTime	ISO8601 datetime	The server date and time
openOrders	list of structures	A list containing structures with information on open orders, see below. The list is sorted descending by receivedTime
receivedTime	ISO8601 datetime	The date and time the order was received
lastUpdateTime	ISO8601 datetime	The date and time the order was last updated
status	string	The status of the order, either of: untouched: the entire size of the order is unfilled partiallyFilled: the size of the order is partially but not entirely filled
order_id	UUID	The unique identifier of the order
cliOrdId	UUID	The unique client order identifier. This field is returned only if the order has a client order id
orderType	string	The order type, either lmt for a limit order or stp for a stop order
symbol	string	The symbol of the futures the order refers to.
side	string	The direction of the order, either buy for a buy order or sell for a sell order
unfilledSize	positive integer	The unfilled size associated with the order
filledSize	positive integer	The filled size associated with the order
limitPrice	positive float	The limit price associated with the order
stopPrice	positive float	If orderType is stp: The stop price associated with the order If orderType is lmt: Not returned because N/A

Sample Return if Unsuccessful

{
   "result":"error",
   "serverTime":"2016-02-25T09:45:53.818Z",
"error":"apiLimitExceeded",
}

Field	Type	Description
result	String	Always error
serverTime	ISO8601 datetime	The server date and time
error	string	The reason the API call failed, either of: apiLimitExceeded: the API limit for the calling IP address has been exceeded authenticationError: the request could not be authenticated accountInactive: the Crypto Facilities account the request refers to is inactive nonceBelowThreshold: <threshold> the provided nonce is below the <threshold> nonceDuplicate: <duplicate> the provided nonce is a duplicate as it has been used in a previous request

Articles in this section