cancel_order {bitmexr}

Cancel order

Description

Cancel an order that has been placed.

Usage

cancel_order(orderID = NULL, clOrdID = NULL, text = NULL)

Arguments

orderID

string. Order ID.

clOrdID

string. Optional client ID set when placing an order.

text

string. Optional cancellation annotation. e.g. 'Spread Exceeded'.

Value

Returns a data.frame with details about the order that was cancelled. See https://www.bitmex.com/api/explorer/#!/Order/Order_cancel for more information.

Examples

## Not run: 
# Cancel an order
cancel_order(clOrdID = "myorderid")

## End(Not run)