This endpoint allows editing an existing order for a currently listed Futures contract.
Authentication is required.
Endpoint |
Request Type | Permissible API Keys |
/api/v3/editorder
|
POST | Read-write, Master |
Argument | Type | Required | Description |
orderId | UUID | No | ID of the order you wish to edit |
size
|
positive integer | No | The size associated with the order |
limitPrice
|
positive float | No | The limit price associated with the order. Must not have more than 2 decimal places |
stopPrice
|
positive float | No | The stop price associated with a stop order. Required if old orderType is stp. Must not have more than 2 decimal places. Note that for stp orders, limitPrice is also required and denotes the worst price at which the stp order can get filled |
cliOrdId
|
UUID | No | The order identity that is specified from the user. It must be globally unique. |
Sample Calls |
https://www.cryptofacilities.com/derivatives/api/v3/editorder?orderId=022774bc-2c4a-4f26-9317-436c8d85746d&size=1501&limitPrice=7400
|
Sample Return if Successful |
{ |
Field |
Type | Description |
result
|
string | Always success |
editStatus
|
structure | A structure containing information on the send order request, see below |
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. |
receivedTime | ISO8601 datetime | The date and time the order was received |
status | string | The status of the order, either of:
|
orderEvents | Structure | Order Events |
serverTime
|
ISO8601 datetime | The server date and time |
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:
|