rgdax (version 1.2.1)

cancel_order: Cancel Pending Orders

Description

This is an auth based function. User must have valid api keys generated by GDAX which must be passed as mandatory arguments. The users can cancel all pending orders except stop orders (GDAX does not treat STOP order as an open order unless the stop price is kicked in). User can now pass an optional order id to cancel a specific order including stop orders. Open orders can now be determined with open_orders. This function is a common call to delete one individual order or deleting all open orders.

Usage

cancel_order(order_id = "all", api.key, secret, passphrase)

Arguments

order_id

Optional character value. This is the order id as generated by GDAX. Default value is "all" which will cancel all open orders.

api.key

Mandatory character value. This is the API key as generated by GDAX. Typically a 32 character value.

secret

Mandatory character value. This is the API secret as generated by GDAX. Typically a 88 character value.

passphrase

Mandatory character value. This is the passphrase as generated by GDAX. Typically a 11 character value.

Value

A Dataframe of order-ids of all orders that were cancelled.

Examples

# NOT RUN {
cancel_order(api.key = your_key,
             secret = your_api_secret,
             passphrase = your_api_pass)

cancel_order(order_id = "a0a00000-0000-000a-a000-a0a0aa00000a",
             api.key = your_key,
             secret = your_api_secret,
             passphrase = your_api_pass)
# }