Cancel Order

Cancel a pending limit order.

Refunds reserved funds (BUY) or restores reserved shares (SELL). Only PENDING orders owned by the authenticated user can be cancelled.

DELETE /v1/orders/{order_id}

Cancel Order

cURL

curl --request DELETE \
  --url https://staging-api.polysimulator.com/v1/orders/{order_id} \
  --header 'X-API-Key: <x-api-key>'

200

{
  "order_id": 123,
  "status": "<string>",
  "order_type": "<string>",
  "side": "<string>",
  "outcome": "<string>",
  "price": "<string>",
  "quantity": "<string>",
  "notional": "<string>",
  "fee": "<string>",
  "filled_at": "<string>",
  "price_source": "<string>",
  "slippage_bps": 123,
  "account_balance": "<string>",
  "position": {}
}

Headers

X-API-Key · string · required

Your PolySimulator API key

Path Parameters

order_id · integer · required

Response

200

application/json

Successful Response

order_id · integer · required

status · string · required

order_type · string · required

side · string · required

outcome · string · required

price · string · required

quantity · string · required

notional · string · required

fee · string · required

filled_at · string | null

price_source · string | null

slippage_bps · integer | null

account_balance · string | null

position · Position · object