Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/backtest-kit/wallet-manager/llms.txt

Use this file to discover all available pages before exploring further.

commitCancel is the definitive “flatten and exit to cash” operation. It is designed around a critical constraint of Binance spot: a resting order (take-profit, stop-loss, or a stale limit entry) locks the base coin or USDT it would need to fill. Attempting to sell over locked funds either fails with an insufficient balance error or silently trades only the unlocked remainder. The correct sequence is always: cancel every pending order, verify the book is empty, and only then sell the full coin balance. commitCancel enforces this sequence unconditionally.
commitCancel places real orders on Binance spot. It will cancel all open orders on the specified symbol — including take-profit and stop-loss brackets — and sell the entire free coin balance to USDT. There is no partial flatten mode. Ensure this is the intended action before calling it.

​
Signature

commitCancel(symbol: string): Promise<number>

​
Parameters

​
symbol
string
required
Binance trading pair symbol to flatten, e.g. "SOLUSDT". All open orders on this symbol will be cancelled and all free coin balance will be sold.

​
Returns

​
exitPrice
number
The average fill price of the sell order in USDT. Returns 0 if the free coin quantity after fee and minQty deductions is at or below minQty (dust) — in that case no sell order is placed and the tiny remainder is left on the account.

​
Execution flow

1

Cancel all open orders

binance.openOrders(symbol) is fetched and every order in the response is cancelled via binance.cancel(symbol, orderId) with a 1-second pause between each cancellation. Individual cancel failures are tolerated — the entire sweep repeats up to 10 times until every order is gone or an unrecoverable error is thrown. If any cancellation error persists after all retries, it is rethrown so the caller can handle it.
2

Verify book is clean

After the cancellation sweep, binance.openOrders(symbol) is polled again — up to 10 times with a 1-second interval — until it returns an empty array. This confirms that the exchange has processed all cancellations and that no funds remain locked. If open orders are still present after all retries, an Error("Order not canceled") is thrown.
3

Sell entire free balance

The current coin balance is fetched via FETCH_BALANCE_FN. The sellable quantity is:
quantity = balance.quantity
         - makerFeePercent(balance.quantity)
         - minQty
If quantity <= minQty the function returns 0 (dust, not worth selling). Otherwise a LIMIT SELL is placed at currentPrice × 0.999. If the limit does not fill within 10 polls of 10 seconds each, it is cancelled and the remainder is submitted as a market sell.

​
Fee accounting

Before placing the sell order, commitCancel subtracts the makerCommission percentage (read from binance.account()) and one minQty unit from the raw balance quantity. This ensures the order quantity is within the exchange’s accepted range and that fees do not cause a post-trade negative balance.

​
Example

const exitPrice = await wallet.walletPublicService.commitCancel("SOLUSDT");

if (exitPrice === 0) {
  console.log("No sell placed — coin balance is below minQty (dust)");
} else {
  console.log(`Exited SOLUSDT at average price: ${exitPrice}`);
}
For the conceptual explanation of why cancel-verify-sell must be a single atomic sequence, see Order Management: Cancel, Verify, Sell.

Build docs developers (and LLMs) love

Get started for freeTalk to us