tn_cancel_order {bitmexr} | R Documentation |
Cancel order (testnet)
Description
Cancel an order that has been placed using the testnet API.
Usage
tn_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
tn_cancel_order(clOrdID = "myorderid")
## End(Not run)
[Package bitmexr version 0.3.3 Index]