Skip to main content

​
Modify Order via WebSocket

To modify orders on Rails platform, use the WebSocket API and subscribe to the Order Creation Stream. The specifications and behavior remain the same.

​
Order Modification Workflow

Order modification is done by submitting a Modify Order request via the Order Creation Stream. You will receive two responses in sequence:
  • Acknowledgment: Confirms the request was received and validates basic parameters. The order is the original, now modifying.
  • Confirmation: The original order has been cancelled and its replacement, with the updated parameters and a new orderId, is on the book. The order is the replacement.
Key differences: An error response in place of the confirmation means nothing changed: the original order stays on the book as it was. Use the clientRequestId to correlate the acknowledgment, the confirmation, and any error response for a single request.

​
Comparison with Cancel and Create Workflow

The order modification workflow provides a more streamlined process with fewer steps and lower overall latency compared to cancelling an order and creating a new one separately. Despite modifying an existing order, the modified order is treated as a new order in the order book with a new order ID, and the original order is cancelled. Since it’s essentially a cancellation followed by a new order creation, it’s subject to the same Order Limits and Restrictions as a regular order creation.