Cancel Order
Cancels an existing open or partially filled order identified by order ID. This action immediately requests order cancellation from the exchange, preventing further execution while preserving any partial fills already completed.
Use Case: Stop unfilled orders when market conditions change or trading strategies need adjustment before complete execution.
Documentation Index
Fetch the complete documentation index at: https://finance.dev/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
OAuth2 Bearer token: obtain an access token from the token endpoint and send it in the Authorization header.
Body
Cancel payload: origClOrdId, accountId, symbol, side, securityType; putCall/strikePrice/maturity for options.
Request body for canceling an open order through the core trading API. Use this when the user wants to stop an order that has not fully filled.
Client order ID of the original order you want to cancel. Use the clOrdId returned by Place Order or List active orders.
1 - 100"ORDER-123456"
Trading account identifier that owns the order being canceled. It must match the account on the original order.
1 - 50"TEST-ACCOUNT-001"
Symbol on the original order. Use the exact symbol from the order record.
1 - 20"AAPL"
Direction of the trade. Use BUY when purchasing shares or contracts, SELL when selling a position you own, SELL_SHORT when opening a short sale, and BUY_TO_COVER when closing a short position.
BUY, SELL, SELL_SHORT, BUY_TO_COVER "BUY"
Type of instrument on the order. Use CS for common stock/equity orders and OPT for option orders.
CS, OPT "CS"
Option contract type for option cancels. Use CALL/C for calls and PUT/P for puts. Omit for equity cancels.
PUT, CALL, P, C "CALL"
Option strike price as a decimal string. Send this for option cancels when the original order was an option order.
"150.00"
Option expiration date in YYYY-MM-DD format. Send this for option cancels when the original order was an option order.
^\d{4}-\d{2}-\d{2}$"2025-01-17"
Response
Cancel request submitted successfully
Response returned after requesting an order cancel. Treat it as the cancel result and continue monitoring if the status is pending.
Whether Aries or the broker accepted the cancel request for processing.
true
Client order ID associated with the cancel action. Store it for audit and status matching.
"ORDER-123456"
Client order ID of the original order being canceled. Use it to connect this cancel result to the user's order.
"ORDER-123456"
Order status after the cancel request. CANCELED means no further fills should occur; pending statuses require continued monitoring.
"CANCELED"
Broker or platform message about the cancel result. Show it when the cancel is rejected or needs explanation.