spot

Cancel an open spot order

Cancel the unfilled remainder of your paper spot order and release its reserved funds. Requires scope trade:spot; get the order id from /api/agent/orders/open. Filled trades are not reversed.

Safe to repeat with the same id. If the order is not open under your key, returns 200 with alreadyClosed: true. This does not distinguish a fill from a prior cancellation or an unknown order. Use /api/agent/trades to check fills; do not treat alreadyClosed as proof that this request cancelled the order.

post/api/agent/spot/order/{id}/cancel

Request

  • Base URL: https://api.coinrithm.com
  • URL: https://api.coinrithm.com/api/agent/spot/order/{id}/cancel
  • Auth: HTTP bearer

Path parameters

idinteger required

The order id returned by /api/agent/orders/open.

Response

Unfilled remainder cancelled, or the order is already not open under this key.

oktrue
alreadyClosedboolean

True when the order is not open under this key. Omitted after this request cancels an open order; does not identify why an order is absent.

Changes

No recorded changes to this operation across all 1 revision of this API.