Send Order – Cryptocurrency Guide - Crypto Facilities

This endpoint allows sending a limit, market, stop, take profit or immediate-or-cancel order for a currently listed Futures contract.

Authentication is required.

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

Argument	Type	Required	Description
orderType	string	Yes	The order type, one of: lmt for a limit order post for a post-only limit order mkt for an immediate-or-cancel order with 1% price protection stp for a stop order take_profit for a take profit order ioc for an immediate-or-cancel order
symbol	string	Yes	The symbol of the Futures, see Section 3.4.4
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 or take profit order. Required if orderType is stp or take_profit. Must not have more than 2 decimal places. Note that for stop orders, limitPrice denotes the worst price at which the stop or take_profit order can get filled at. If no limitPrice is provided the stop or take_profit order will trigger a market order.
triggerSignal	string	No	If placing a stp or take_profit, the signal used for trigger. One of: mark - the mark price index - the index price last - the last executed trade
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 existing position. Any order which increases an existing position will be rejected. Default false.

Sample Calls

https://www.cryptofacilities.com/derivatives/api/v3/sendorder?orderType=lmt&symbol=pi_xbtusd&side=buy&size=10000&limitPrice=9400&reduceOnly=true

https://www.cryptofacilities.com/derivatives/api/v3/sendorder?orderType=lmt&symbol=pi_xbtusd&side=buy&size=10000&limitPrice=9400

https://www.cryptofacilities.com/derivatives/api/v3/sendorder?orderType=take_profit&symbol=PI_XBTUSD&side=buy&size=10&limitPrice=15000&stopPrice=9500&triggerSignal=mark

https://www.cryptofacilities.com/derivatives/api/v3/sendorder?orderType=lmt&symbol=pi_xbtusd&side=sell&size=100000&limitPrice=10640&reduceOnly=true

https://www.cryptofacilities.com/derivatives/api/v3/sendorder?orderType=lmt&symbol=PI_XBTUSD&side=buy&size=10&limitPrice=7500

Sample Return if Successful

{
   "result":"success",
   "sendStatus":{
      "order_id":"614a5298-0071-450f-83c6-0617ce8c6bc4",
      "status":"wouldNotReducePosition",
      "receivedTime":"2019-09-05T16:32:54.076Z",
      "orderEvents":[
         {
            "uid":"614a5298-0071-450f-83c6-0617ce8c6bc4",
            "order":{
               "orderId":"614a5298-0071-450f-83c6-0617ce8c6bc4",
               "cliOrdId":null,
               "type":"lmt",
               "symbol":"pi_xbtusd",
               "side":"buy",
               "quantity":10000,
               "filled":0,
               "limitPrice":9400,
               "reduceOnly":true,
               "timestamp":"2019-09-05T16:32:54.076Z",
               "lastUpdateTimestamp":"2019-09-05T16:32:54.076Z"
            },
            "reason":"WOULD_NOT_REDUCE_POSITION",
            "type":"REJECT"
         }
      ]
   },
   "serverTime":"2019-09-05T16:32:54.077Z"
}

{
   "result":"success",
   "sendStatus":{
      "order_id":"179f9af8-e45e-469d-b3e9-2fd4675cb7d0",
      "status":"placed",
      "receivedTime":"2019-09-05T16:33:50.734Z",
      "orderEvents":[
         {
            "order":{
               "orderId":"179f9af8-e45e-469d-b3e9-2fd4675cb7d0",
               "cliOrdId":null,
               "type":"lmt",
               "symbol":"pi_xbtusd",
               "side":"buy",
               "quantity":10000,
               "filled":0,
               "limitPrice":9400,
               "reduceOnly":false,
               "timestamp":"2019-09-05T16:33:50.734Z",
               "lastUpdateTimestamp":"2019-09-05T16:33:50.734Z"
            },
            "reducedQuantity":null,
            "type":"PLACE"
         }
      ]
   },
   "serverTime":"2019-09-05T16:33:50.734Z"
}

{
   "result":"success",
   "sendStatus":{
      "order_id":"1abfd3c6-af93-4b30-91cc-e4a93797f3f5",
      "status":"placed",
      "receivedTime":"2019-12-05T10:20:50.701Z",
      "orderEvents":[
         {
            "orderTrigger":{
               "uid":"1abfd3c6-af93-4b30-91cc-e4a93797f3f5",
               "clientId":null,
               "type":"lmt",
               "symbol":"pi_xbtusd",
               "side":"buy",
               "quantity":10,
               "limitPrice":15000,
               "triggerPrice":9500,
               "triggerSide":"trigger_below",
               "triggerSignal":"mark_price",
               "reduceOnly":false,
               "timestamp":"2019-12-05T10:20:50.701Z",
               "lastUpdateTimestamp":"2019-12-05T10:20:50.701Z"
            },
            "type":"PLACE"
         }
      ]
   },
   "serverTime":"2019-12-05T10:20:50.702Z"
}

{
   "result":"success",
   "sendStatus":{
      "order_id":"d08021f7-58cb-4f2c-9c86-da4c60de46bb",
      "status":"placed",
      "receivedTime":"2019-09-05T16:38:43.651Z",
      "orderEvents":[
         {
            "order":{
               "orderId":"d08021f7-58cb-4f2c-9c86-da4c60de46bb",
               "cliOrdId":null,
               "type":"lmt",
               "symbol":"pi_xbtusd",
               "side":"sell",
               "quantity":10000,
               "filled":0,
               "limitPrice":10640,
               "reduceOnly":true,
               "timestamp":"2019-09-05T16:38:43.651Z",
               "lastUpdateTimestamp":"2019-09-05T16:38:43.651Z"
            },
            "reducedQuantity":0,
            "type":"PLACE"
         }
      ]
   },
   "serverTime":"2019-09-05T16:38:43.652Z"
}

{
   "result":"success",
   "sendStatus":{
      "order_id":"61ca5732-3478-42fe-8362-abbfd9465294",
      "status":"placed",
      "receivedTime":"2019-12-11T17:17:33.888Z",
      "orderEvents":[
         {
            "executionId":"e1ec9f63-2338-4c44-b40a-43486c6732d7",
            "price":7244.5,
            "amount":10,
            "orderPriorEdit":null,
            "orderPriorExecution":{
               "orderId":"61ca5732-3478-42fe-8362-abbfd9465294",
               "cliOrdId":null,
               "type":"lmt",
               "symbol":"pi_xbtusd",
               "side":"buy",
               "quantity":10,
               "filled":0,
               "limitPrice":7500,
               "reduceOnly":false,
               "timestamp":"2019-12-11T17:17:33.888Z",
               "lastUpdateTimestamp":"2019-12-11T17:17:33.888Z"
            },
            "takerReducedQuantity":null,
            "type":"EXECUTION"
         }
      ]
   },
   "serverTime":"2019-12-11T17:17:33.888Z"
}

Field	Type	Description
result	string	Always success
sendStatus	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: 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. wouldCauseLiquidation: returned when a new order would fill at a worse price than the mark price, causing the portfolio value to fall below maintenance margin and triggering a liquidation. wouldNotReducePosition: the reduce only order would not reduce position.
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