GuidesAPI Reference
DocumentationLog In

Cancel a single open order by {id}.

📘

Cancel a previously placed order. The order must belong to the profile that the API key belongs to.

If the order had no matches during its lifetime, its record may be purged. This means the order details will not be available with GET /orders/<id>.

🚧

To prevent a race condition when canceling an order, it is highly recommended that you specify the product id as a query string.

API Key Permissions

This endpoint requires the "trade" permission.

Orders may be canceled using either the exchange assigned id or the client assigned client_oid. When using client_oid it must be preceded by the client: namespace.

Response

Successfully cancelled order response will include the order ID if requested cancellation is by exchange assigned id, or the client assigned client_oid if cancelled by client order ID.

Cancel Reject

If the order could not be canceled (already filled or previously canceled, etc), then an error response will indicate the reason in the message field.

Language
Authentication
Click Try It! to start a request and see the response here!