Cancel all orders

POST 
/cancelallorders

This endpoint allows cancelling orders which are associated with a future's contract or a margin account. If no arguments are specified all open orders will be cancelled.

Request

application/json

Body

required

symbol string

A futures product to cancel all open orders.

Responses

200

application/json

Schema

Schema

oneOf

Success Response

cancelStatus object

A structure containing information on the cancellation request.

cancelOnly string

The symbol of the futures or all.

cancelledOrders object[]

A list of structures containing all the successfully cancelled orders.

Array [

cliOrdId stringnull

Possible values: <= 100 characters

Unique client order identifier.

order_id uuid

Order ID.

]

orderEvents object[]

Array [

type string

Possible values: [CANCEL]

Always CANCEL.

uid string

The UID associated with the order.

order object

oneOf

OrderJson

orderId string

The UID associated with the order.

cliOrdId stringnull

The client order id or null if order does not have one.

type string

Possible values: [lmt, ioc, post, liquidation, assignment, stp, unwind, block]

The order type

symbol string

The symbol of the Futures.

side string

Possible values: [buy, sell]

The side associated with the order

quantity number

The quantity (size) associated with the order.

filled number

The total amount of the order that has been filled.

limitPrice number

The limit price associated with a limit order.

reduceOnly boolean

Is the order a reduce only order or not.

timestamp string

The date and time the order was placed.

lastUpdateTimestamp string

The date and time the order was edited.

]

receivedTime string

The date and time the order cancellation was received.

status string

Possible values: [noOrdersToCancel, cancelled]

The status of the order cancellation:

• cancelled - successful cancellation
• noOrdersToCancel - no open orders for cancellation

result stringrequired

Possible values: [success]

serverTime date-timerequired

Server time in Coordinated Universal Time (UTC)

ErrorResponse

errors Error (string)[]

Possible values: [accountInactive, apiLimitExceeded, authenticationError, insufficientFunds, invalidAccount, invalidAmount, invalidArgument, invalidUnit, Json Parse Error, marketUnavailable, nonceBelowThreshold, nonceDuplicate, notFound, requiredArgumentMissing, Server Error, Unavailable, unknownError]

error Error (string)

Possible values: [accountInactive, apiLimitExceeded, authenticationError, insufficientFunds, invalidAccount, invalidAmount, invalidArgument, invalidUnit, Json Parse Error, marketUnavailable, nonceBelowThreshold, nonceDuplicate, notFound, requiredArgumentMissing, Server Error, Unavailable, unknownError]

Error description.

• accountInactive: The Futures account the request refers to is inactive
• apiLimitExceeded: The API limit for the calling IP address has been exceeded
• authenticationError: The request could not be authenticated
• insufficientFunds: The amount requested for transfer is below the amount of funds available
• invalidAccount: The Futures account the transfer request refers to is invalid
• invalidAmount: The amount the transfer request refers to is invalid
• invalidArgument: One or more arguments provided are invalid
• invalidUnit: The unit the transfer request refers to is invalid
• Json Parse Error: The request failed to pass valid JSON as an argument
• marketUnavailable: The market is currently unavailable
• nonceBelowThreshold: The provided nonce is below the threshold
• nonceDuplicate: The provided nonce is a duplicate as it has been used in a previous request
• notFound: The requested information could not be found
• requiredArgumentMissing: One or more required arguments are missing
• Server Error: There was an error processing the request
• Unavailable: The endpoint being called is unavailable
• unknownError: An unknown error has occurred

result stringrequired

Possible values: [error]

serverTime date-timerequired

Server time in Coordinated Universal Time (UTC)

success

{
  "result": "success",
  "cancelStatus": {
    "receivedTime": "2019-08-01T15:57:37.518Z",
    "cancelOnly": "all",
    "status": "cancelled",
    "cancelledOrders": [
      {
        "order_id": "6180adfa-e4b1-4a52-adac-ea5417620dbd"
      },
      {
        "order_id": "89e3edbe-d739-4c52-b866-6f5a8407ff6e"
      },
      {
        "order_id": "0cd37a77-1644-4960-a7fb-9a1f6e0e46f7"
      }
    ],
    "orderEvents": [
      {
        "type": "CANCEL",
        "uid": "89e3edbe-d739-4c52-b866-6f5a8407ff6e",
        "order": {
          "orderId": "89e3edbe-d739-4c52-b866-6f5a8407ff6e",
          "type": "post",
          "symbol": "PI_XBTUSD",
          "side": "buy",
          "quantity": 890,
          "filled": 0,
          "limitPrice": 10040,
          "reduceOnly": false,
          "timestamp": "2019-08-01T15:57:08.508Z",
          "lastUpdateTimestamp": "2019-08-01T15:57:08.508Z"
        }
      },
      {
        "type": "CANCEL",
        "uid": "0cd37a77-1644-4960-a7fb-9a1f6e0e46f7",
        "order": {
          "orderId": "0cd37a77-1644-4960-a7fb-9a1f6e0e46f7",
          "type": "lmt",
          "symbol": "PI_XBTUSD",
          "side": "sell",
          "quantity": 900,
          "filled": 0,
          "limitPrice": 10145,
          "reduceOnly": true,
          "timestamp": "2019-08-01T15:57:14.003Z",
          "lastUpdateTimestamp": "2019-08-01T15:57:14.003Z"
        }
      }
    ]
  },
  "serverTime": "2019-08-01T15:57:37.520Z"
}

Loading...