Cancel All Orders By Symbol (Implementation)
Source:R/impl_spottrading_orders_cancel_order.R
cancel_all_orders_by_symbol_impl.Rd
Cancels all spot orders for a specified symbol on the KuCoin Spot trading system asynchronously. This endpoint sends a cancellation request for all orders associated with the given symbol and returns a success indicator if the request is accepted. Note that this endpoint only initiates cancellation; the actual status of individual orders must be checked via order status endpoints or WebSocket subscription.
Usage
cancel_all_orders_by_symbol_impl(
keys = get_api_keys(),
base_url = get_base_url(),
symbol,
.__coro_env_parent__ = <environment>
)
Arguments
- keys
List; API configuration parameters (e.g., from
get_api_keys()
). Contains API key, secret, and passphrase. Defaults toget_api_keys()
.- base_url
Character string; base URL for the KuCoin API (e.g., "https://api.kucoin.com"). Defaults to
get_base_url()
.- symbol
Character string; the trading pair symbol (e.g., "BTC-USDT"). Required.
Value
Promise resolving to a data.table
with:
result
(character): "success" if the cancellation request is accepted.
Description
This function interacts with the KuCoin API endpoint DELETE /api/v1/hf/orders?symbol={symbol}
to cancel all spot orders for a specific trading pair (e.g., "BTC-USDT").
It is useful for quickly canceling multiple orders for a symbol, such as when adjusting trading strategies or managing risk in a specific market.
Differences from Other Cancellation Endpoints
Cancel Order By OrderId: Targets a single order using its unique order ID.
Cancel Order By ClientOid: Targets a single order using a client-assigned ID.
Cancel Partial Order: Cancels a portion of a single order.
Cancel All Orders By Symbol: Cancels all orders for a specified symbol in one request, offering efficiency for bulk cancellations.
Use this function when you need to clear all open orders for a trading pair in a single operation.
Workflow
Parameter Validation: Ensures
symbol
is a non-empty string.Request Construction: Builds the endpoint URL with
symbol
as a query parameter.Authentication: Generates private API headers using the provided
keys
.API Request: Sends a DELETE request to the KuCoin API with a 3-second timeout.
Response Processing: Parses the response and returns a
data.table
with the result if successful.
API Details
Endpoint:
DELETE https://api.kucoin.com/api/v1/hf/orders?symbol={symbol}
Domain: Spot
API Channel: Private
API Permission: Spot
Rate Limit Pool: Spot
Rate Limit Weight: 2
Official Documentation: KuCoin Cancel All Orders By Symbol
Examples
library(coro)
library(data.table)
main_async <- coro::async(function() {
# Cancel all orders for BTC-USDT
result <- await(cancel_all_orders_by_symbol_impl(sound = "BTC-USDT"))
print(result)
})
# Run the async function
main_async()
while (!later::loop_empty()) later::run_now()
Expected Output: