Edit Order – Cryptocurrency Guide - Crypto Facilities

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

{
   "result":"success",
   "serverTime":"2019-09-05T16:47:47.521Z",
   "editStatus":{
      "status":"edited",
      "orderId":"022774bc-2c4a-4f26-9317-436c8d85746d",
      "receivedTime":"2019-09-05T16:47:47.521Z",
      "orderEvents":[
         {
            "old":{
               "orderId":"022774bc-2c4a-4f26-9317-436c8d85746d",
               "cliOrdId":null,
               "type":"lmt",
               "symbol":"pi_xbtusd",
               "side":"buy",
               "quantity":1000,
               "filled":0,
               "limitPrice":9400.0,
               "reduceOnly":false,
               "timestamp":"2019-09-05T16:41:35.173Z",
               "lastUpdateTimestamp":"2019-09-05T16:41:35.173Z"
            },
            "new":{
               "orderId":"022774bc-2c4a-4f26-9317-436c8d85746d",
               "cliOrdId":null,
               "type":"lmt",
               "symbol":"pi_xbtusd",
               "side":"buy",
               "quantity":1501,
               "filled":0,
               "limitPrice":7200,
               "reduceOnly":false,
               "timestamp":"2019-09-05T16:41:35.173Z",
               "lastUpdateTimestamp":"2019-09-05T16:47:47.519Z"
            },
            "reducedQuantity":null,
            "type":"EDIT"
         }
      ]
   }
}

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: edited: the order was edited successfully invalidSize: the order was not placed because size is invalid invalidPrice: the order was not placed because limitPrice and/or stopPrice are invalid insufficientAvailableFunds: the order was not placed because available funds are insufficient selfFill: the order was not placed because it would be filled against an existing order belonging to the same account tooManySmallOrders: the order was not placed because the number of small open orders would exceed the permissible limit outsidePriceCollar: the limit order crosses the spread but is an order of magnitude away from the mark price - fat finger control postWouldExecute: the post-only order would be filled upon placement, thus is cancelled wouldNotReducePosition: the edit cannot be applied because the reduce only policy is violated. (Only for reduceOnly orders) orderForEditNotFound: the requested order for edit has not been found orderForEditNotAStop: the supplied stopPrice cannot be applied because order is not a stop order
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: 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 requiredArgumentMissing: a required argument was missing invalidArgument: <argument>:argument "<argument>" is invalid 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