Batch Order – Cryptocurrency Guide - Crypto Facilities

This endpoint allows sending limit or stop order(s) and/or cancelling open order(s) and/or editing open order(s) for a currently listed Futures contract in batch.

Authentication is required.

Endpoint	Request Type	Permissible API Keys
/api/v3/batchorder	POST	Read-write, Master

Argument	Type	Required	Description
json	structure of list	Yes	Contains the list batchOrder
batchOrder	list of structures	Yes	A list containing structures of order sending and order cancellation instructions, see below. The list is in no particular order
Order Placement
order	string	Yes	Always send
order_tag	string	Yes	An arbitrary string provided client-side to tag the order for the purpose of mapping order sending instructions to the API’s response
orderType	string	Yes	either lmt for a limit order, post for a post-only limit order or stp for a stop order
symbol	string	Yes	The symbol of the Futures
side	string	Yes	The direction of the order, either buy for a buy order or sell for a sell order
size	positive integer	Yes	The size associated with the order
limitPrice	positive float	Yes	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 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.
reduceOnly	string	No	Set as 'true' if you wish the order to only reduce an exisiting position. Any order which increases an existing position will be rejected. Default 'false'.
Order Cancellation
order	string	Yes	Always cancel
order_id	UUID	No	The unique identifier of the order to be cancelled
cliOrdId	UUID	No	The unique client identifier of the order to be cancelled
Order Edit
order	UUID	Yes	Always edit
order_id	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 Call

https://www.cryptofacilities.com/derivatives/api/v3/batchorder?json={'batchOrder': [{'reduceOnly': 'false', 'symbol': 'PI_XBTUSD', 'size': 1000, 'orderType': 'lmt', 'order': 'send', 'order_tag': '1', 'side': 'buy', 'limitPrice': 9400.0}, {'order': 'edit', 'order_id': '022f6393-11ef-4eb7-ac1b-266f62f1c153', 'size': 1000, 'limitPrice': 9400.0}, {'order': 'cancel', 'order_id': 'd77eee0d-5ed2-4ae4-ac16-de0d145d1b85'}]}

Example Authent Generation:

Public Key	YF20J/d7vwsurRbu/Iq6u7eU/gi49AbHzyuZt8VSwdVpJvOJ3X954MsT
Private Key	yzKjV2AAo0e+yI6RB08cw8RaTyd4O+T4jtdpSVEZLW3xXqB6mDs1SBHEpIFRcJ37dWMwQ8j0+lFPsROQEjJQ/Kxq
Authent	wRTH1utD8dgmgNncjXS+nmydDRbbS7KchEDLaLx3Oie5AVz1gBuDZC1aBWQ4HXdvXKOxNuzr/SUn5NDM41oaGQ==

URL encoded (Only if data is sent in the URL):

https://www.cryptofacilities.com/derivatives/api/v3/batchorder?
json%3D%7B%27batchOrder%27%3A%20%5B%7B%27order%27%3A%20%27send%27%2C%20%27order_tag%27%3A%20%271%27%2C%20%27limitPrice%27%3A%209400.0%2C%20%27side%27%3A%20%27buy%27%2C%20%27size%27%3A%201000%2C%20%27orderType%27%3A%20%27lmt%27%2C%20%27reduceOnly%27%3A%20%27false%27%2C%20%27symbol%27%3A%20%27PI_XBTUSD%27%7D%2C%20%7B%27order%27%3A%20%27edit%27%2C%20%27size%27%3A%201000%2C%20%27limitPrice%27%3A%209400.0%2C%20%27orderId%27%3A%20%274e81edc1-d276-4d01-82b4-7d56fd0e3688%27%7D%2C%20%7B%27order%27%3A%20%27cancel%27%2C%20%27order_id%27%3A%20%27dc739cdd-5946-41f7-9fad-a192a8035a37%27%7D%5D%7D7D

Sample Return if Successful

{
   "result":"success",
   "serverTime":"2019-09-05T16:41:40.996Z",
   "batchStatus":[
      {
         "status":"placed",
         "order_tag":"1",
         "order_id":"022774bc-2c4a-4f26-9317-436c8d85746d",
         "dateTimeReceived":"2019-09-05T16:41:35.173Z",
         "orderEvents":[
            {
               "order":{
                  "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"
               },
               "reducedQuantity":null,
               "type":"PLACE"
            }
         ]
      },
      {
         "status":"edited",
         "order_id":"9c2cbcc8-14f6-42fe-a020-6e395babafd1",
         "orderEvents":[
            {
               "old":{
                  "orderId":"9c2cbcc8-14f6-42fe-a020-6e395babafd1",
                  "cliOrdId":null,
                  "type":"lmt",
                  "symbol":"pi_xbtusd",
                  "side":"buy",
                  "quantity":102.00,
                  "filled":0.00,
                  "limitPrice":8500.00000000,
                  "reduceOnly":false,
                  "timestamp":"2019-09-04T11:45:48.884Z",
                  "lastUpdateTimestamp":"2019-09-04T11:45:48.884Z"
               },
               "new":{
                  "orderId":"9c2cbcc8-14f6-42fe-a020-6e395babafd1",
                  "cliOrdId":null,
                  "type":"lmt",
                  "symbol":"pi_xbtusd",
                  "side":"buy",
                  "quantity":1000,
                  "filled":0.00,
                  "limitPrice":9400.0,
                  "reduceOnly":false,
                  "timestamp":"2019-09-04T11:45:48.884Z",
                  "lastUpdateTimestamp":"2019-09-05T16:41:40.996Z"
               },
               "reducedQuantity":null,
               "type":"EDIT"
            }
         ]
      },
      {
         "status":"cancelled",
         "order_id":"566942c8-a3b5-4184-a451-622b09493129",
         "orderEvents":[
            {
               "uid":"566942c8-a3b5-4184-a451-622b09493129",
               "order":{
                  "orderId":"566942c8-a3b5-4184-a451-622b09493129",
                  "cliOrdId":null,
                  "type":"lmt",
                  "symbol":"pi_xbtusd",
                  "side":"buy",
                  "quantity":100.00,
                  "filled":0.00,
                  "limitPrice":8500.00000000,
                  "reduceOnly":false,
                  "timestamp":"2019-09-02T12:54:08.005Z",
                  "lastUpdateTimestamp":"2019-09-02T12:54:08.005Z"
               },
               "type":"CANCEL"
            }
         ]
      }
   ]
}

Field	Type	Description
result	String	Always success
serverTime	ISO8601 datetime	The server date and time
batchStatus	list of structures	A structure containing information on the send order request, see below
Sent Orders
dateTimeReceived	ISO8601 datetime	The date and time the order was received
status	string	The status of the order, either of: placed: the order was placed successfully cancelled: the order was cancelled successfully invalidOrderType: the order was not placed because orderType is invalid invalidSide: the order was not placed because side is invalid 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 marketSuspended: the order was not placed because the market is suspended marketInactive: the order was not placed because the market is inactive clientOrderIdAlreadyExist: the specified client id already exist clientOrderIdTooLong: the client id is longer than 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 iocWouldNotExecute: the immediate-or-cancel order would not execute
orderEvents	Structure	Order Events
order_id	UUID	The unique identifier of the order
order_tag	string	The arbitrary string provided client-side when the order was sent for the purpose of mapping order sending instructions to the API’s response
cliOrdId	UUID	The unique client order identifier. This field is returned only if the order has a client order id.
Order Cancellations
receivedTime	ISO8601 datetime	The date and time the order cancellation was received
status	string	The status of the order cancelation, either of: cancelled: the order was found untouched and the entire size was cancelled successfully filled: the order was found completely filled and could not be cancelled notFound: the order was not found, either because it had already been cancelled or it never existed requiredArgumentMissing: the request does not contain order_id and/or cliOrdId parameters
order_id	string	The cancelled order id
cliOrdId	string	The client order id. Shown only if exists
Order Edits
receivedTime	ISO8601 datetime	The date and time the order cancellation 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
order_id	string	The edited order id
cliOrdId	string	The client order id. Shown only if exists

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 Bad Request: The URL contains invalid characters. (Please encode the json URL parameter)

Articles in this section