Cancel several orders

Cancel a specific set of orders in one call. batched is a literal path segment, never read as an order_id. Requires a read_write key.

DELETE

https://demo.stxapp.iohttps://demo.stxapp.cahttps://api.on.stxapp.ca/api/v1/orders/batched

Try it ▶

Try it

Base URL

Key ID stx_access_keyPrivate key (PEM or base64 seed) stx_private_key

Request

Send requestShow signed headersClear saved key

Every endpoint, in one place: the full Try it.

Signing happens in your browser with WebCrypto. Your private key is never sent anywhere; Send request sends your key ID and the signature to the demo host above. Only demo hosts are offered. The key ID and private key are saved in this browser's local storage, per jurisdiction, until you click Clear saved key. Use a demo key here, never a production one.

In the SDKs

• TypeScript: STX.cancelOrders()
• Python: STX.cancel_orders()
• C#: STXOrderService.CancelOrdersAsync()

Request body

Field	Type	Required	Description
geo_location	string,null	no	Location code from the STX geolocation check, covering every order in the request. Read only in environments that enforce geo-fencing, and ignored elsewhere. Where it is read, omitting it is a 422 (Placing Order(s) from this IP address … is disallowed.) unless that environment accepts the network location the request arrives from in its place, which it can refuse for an address identified as a VPN, proxy or hosting provider. Do not rely on omitting it: send the code whenever you have one. A code that is sent is always checked, so a bad one is a 422 even where omitting it would have been accepted.
orders	object[]	yes	The orders to cancel. Each entry is an object carrying an order_id, not a bare id string. A flat {"order_ids": [...]} is the common first guess and returns 400 {"error": "orders is required"}, which does not hint that the field exists with a different shape.

Responses

Status	Description	Schema
200	Success	object
400	A parameter was missing or invalid.	Error
401	Missing, malformed or unrecognized signature, or a timestamp outside the 30-second window. Body: {“error”:“Missing or invalid API key credentials”}	Error
403	This API key does not have write access. The account behind this key is not active, for example it is pending approval or suspended. Body: {“error”:“Your account is suspended. Contact support.”}, the message naming the account’s status.	Error
422	The cancel was refused, for example by the location check or because the order can no longer be cancelled. The body’s error says why.	Error

Example

Request:

curl --request DELETE \
  --url 'https://demo.stxapp.io/api/v1/orders/batched' \
  --header 'X-STX-ACCESS-KEY: <key-id>' \
  --header 'X-STX-ACCESS-TIMESTAMP: <unix-ms>' \
  --header 'X-STX-ACCESS-SIGNATURE: <base64-ed25519>' \
  --header 'Content-Type: application/json' \
  --data '{
  "geo_location": null,
  "orders": [
    {
      "order_id": "a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d"
    }
  ]
}'

Response 200:

{
  "cancellations": [
    {
      "order_id": "a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
      "status": "cancelled"
    }
  ]
}

Response fields

Field	Type	Description
order_id	uuid	The order this outcome relates to.
status	string	The order status after cancelling, or a reason it was not cancelled, such as “Order not found” for an unknown id.