Cancel order

POST 
/cancelorder

This endpoint allows cancelling an open order for a Futures contract.

Request

application/json

Body

required

ProcessBefore

The time before which the request should be processed, otherwise it is rejected.

order_id string

The unique identifier of the order to be cancelled.

cliOrdId string

The client unique identifier of the order to be cancelled.

Responses

200

application/json

Schema

Schema

oneOf

Success Response

cancelStatus object

A structure containing information on the cancellation request.

cliOrdId stringnull

The client order ID. Shown only if client specified one.

orderEvents object[]

Array [

oneOf

PlaceEvent

type string

Possible values: [PLACE]

Always PLACE.

order object

The placed order.

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.

reducedQuantity numbernull

The amount of quantity that was removed before placement or null if the order is not a reduce only.

CancelEvent

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.

EditEvent

type string

Possible values: [EDIT]

Always EDIT.

old object

The order before the edit was applied.

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.

new object

The order after the edit was applied.

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.

reducedQuantity numbernull

The amount of quantity that was removed from the edited order or null if the order is not a reduce only.

RejectEvent

type string

Possible values: [REJECT]

Always REJECT.

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.

reason string

Possible values: [POST_WOULD_EXECUTE, IOC_WOULD_NOT_EXECUTE]

The rejection reason:

• POST_WOULD_EXECUTE - The post-only order would be filled upon placement, thus is cancelled.
• IOC_WOULD_NOT_EXECUTE - The immediate-or-cancel order would not execute.

ExecuteEvent

type string

Possible values: [EXECUTION]

Always EXECUTION.

executionId string

The UID associated with the execution.

price number

The price of the execution.

amount number

The executed amount.

orderPriorEdit 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.

orderPriorExecution object

The order before it executes.

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.

takerReducedQuantity numbernull

The amount of quantity that was removed from the order before execution or null if the order is not a reduce only.

PlaceTriggerEvent

type string

Possible values: [PLACE]

Always PLACE.

orderTrigger object

uid string

The UID associated with the order.

clientId stringnull

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

type string

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

The order type

symbol string

The symbol of the Futures.

side string

Possible values: [buy, sell]

The side associated with the order

quantity numbernull

The quantity (size) associated with the order.

limitPrice numbernull

The limit price associated with a limit order.

triggerPrice numbernull

triggerSide stringnull

Possible values: [trigger_above, trigger_below]

triggerSignal stringnull

Possible values: [mark_price, last_price, spot_price]

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.

startTime stringnull

CancelTriggerEvent

type string

Possible values: [CANCEL]

Always CANCEL.

uid string

orderTrigger object

oneOf

OrderTriggerJson

uid string

The UID associated with the order.

clientId stringnull

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

type string

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

The order type

symbol string

The symbol of the Futures.

side string

Possible values: [buy, sell]

The side associated with the order

quantity numbernull

The quantity (size) associated with the order.

limitPrice numbernull

The limit price associated with a limit order.

triggerPrice numbernull

triggerSide stringnull

Possible values: [trigger_above, trigger_below]

triggerSignal stringnull

Possible values: [mark_price, last_price, spot_price]

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.

startTime stringnull

RejectTriggerEvent

type string

Possible values: [REJECT]

Always REJECT.

uid string

orderTrigger object

oneOf

OrderTriggerJson

uid string

The UID associated with the order.

clientId stringnull

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

type string

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

The order type

symbol string

The symbol of the Futures.

side string

Possible values: [buy, sell]

The side associated with the order

quantity numbernull

The quantity (size) associated with the order.

limitPrice numbernull

The limit price associated with a limit order.

triggerPrice numbernull

triggerSide stringnull

Possible values: [trigger_above, trigger_below]

triggerSignal stringnull

Possible values: [mark_price, last_price, spot_price]

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.

startTime stringnull

reason OrderError (string)

Possible values: [MARKET_SUSPENDED, MARKET_NOT_FOUND, INVALID_PRICE, INVALID_QUANTITY, SMALL_ORDER_LIMIT_EXCEEDED, INSUFFICIENT_MARGIN, WOULD_CAUSE_LIQUIDATION, CLIENT_ORDER_ID_IN_USE, CLIENT_ORDER_ID_TOO_LONG, MAX_POSITION_EXCEEDED, PRICE_COLLAR, PRICE_DISLOCATION, EDIT_HAS_NO_EFFECT, ORDER_FOR_CANCELLATION_NOT_FOUND, ORDER_FOR_EDIT_NOT_FOUND, ORDER_CANNOT_HAVE_TRIGGER_PRICE, POST_WOULD_EXECUTE, IOC_WOULD_NOT_EXECUTE, WOULD_EXECUTE_SELF, WOULD_NOT_REDUCE_POSITION, REJECTED_AFTER_EXECUTION, MARKET_IS_POST_ONLY, ORDER_LIMIT_EXCEEDED, FIXED_LEVERAGE_TOO_HIGH, CANNOT_EDIT_TRIGGER_PRICE_OF_TRAILING_STOP, CANNOT_EDIT_LIMIT_PRICE_OF_TRAILING_STOP, TRAILING_STOP_ORDER_LIMIT_EXCEEDED, TRAILING_STOP_PERCENT_DEVIATION_EXCEEDS_MAX_DECIMAL_PLACES, TRAILING_STOP_QUOTE_DEVIATION_NOT_MULTIPLE_OF_TICK_SIZE, TRAILING_STOP_MAX_DEVIATION_TOO_LARGE, TRAILING_STOP_MAX_DEVIATION_TOO_SMALL, INSUFFICIENT_HEADROOM_AROUND_CURRENT_PRICE_TO_EDIT_TRAILING_STOP, NO_REFERENCE_PRICE_AVAILABLE_FOR_CALCULATING_TRAILING_STOP_TRIGGER_PRICE, INSUFFICIENT_CLOSING_MARGIN, LIMIT_PRICE_SET_AS_ABSOLUTE_AND_RELATIVE, LIMIT_PRICE_OFFSET_VALUE_INVALID, LIMIT_PRICE_OFFSET_UNIT_INVALID, LIMIT_PRICE_OFFSET_MUST_HAVE_VALUE_AND_UNIT, LIMIT_PRICE_OFFSET_QUOTE_CURRENCY_VALUE_MUST_BE_MULTIPLE_OF_TICK_SIZE, LIMIT_PRICE_OFFSET_PERCENT_VALUE_TOO_MANY_DECIMAL_PLACES, LIMIT_PRICE_OFFSET_TOO_HIGH, LIMIT_PRICE_OFFSET_TOO_LOW]

]

order_id uuid

The cancelled order UID

receivedTime string

The date and time the order cancellation was received.

status string

Possible values: [cancelled, filled, notFound]

The status of the order cancellation:

• cancelled - The order has been cancelled. This may only be part of the order as part may have been filled. Check open_orders websocket feed for status of the order.
• 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

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": {
    "status": "cancelled",
    "order_id": "cb4e34f6-4eb3-4d4b-9724-4c3035b99d47",
    "receivedTime": "2020-07-22T13:26:20.806Z",
    "orderEvents": [
      {
        "type": "CANCEL",
        "uid": "cb4e34f6-4eb3-4d4b-9724-4c3035b99d47",
        "order": {
          "orderId": "cb4e34f6-4eb3-4d4b-9724-4c3035b99d47",
          "cliOrdId": "1234568",
          "type": "lmt",
          "symbol": "PI_XBTUSD",
          "side": "buy",
          "quantity": 5500,
          "filled": 0,
          "limitPrice": 8000,
          "reduceOnly": false,
          "timestamp": "2020-07-22T13:25:56.366Z",
          "lastUpdateTimestamp": "2020-07-22T13:25:56.366Z"
        }
      }
    ]
  },
  "serverTime": "2020-07-22T13:26:20.806Z"
}

Loading...