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 |
{ |
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:
|
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 |
algoId | string | Algo ID used to submit the order |
reduceOnly | boolean | Is the order reduce only |
limitPrice | positive float | The limit price associated with the order |
stopPrice | positive float |
|
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:
|