Skip to main content

POST Cancel Order

Cancel order by ID NT8​

Cancels one working order by ID on the selected NT8 account.

Endpoint​

POST /v1/api/accounts/{account}/orders/{orderId}/cancel

Headers​

NameValue
Content-Typeapplication/json
AuthorizationBearer <token>

Path parameters​

NameTypeRequiredDescription
accountstringRequiredName of account in NT8
orderIdstringRequiredID of the order in NT8

Code examples​

import requests

token = 'my-secret-token'

url = "https://app.crosstrade.io/v1/api/accounts/Sim101/orders/ce0a8e5002ea463e856eb6384f5cee7e/cancel"
headers = {
"Authorization": f"Bearer {token}",
"Content-Type": "application/json"
}
data = {}

try:
response = requests.post(url, headers=headers, json=data)
print(f"Response Code: {response.status_code}, Response Text: {response.text}")
except Exception as e:
print(f"An error occurred: {e}")

Response​

{
"orderId": "ce0a8e5002ea463e856eb6384f5cee7e",
"success": true
}

Success field types​

FieldTypeDescription
successbooleanCancellation request accepted.
orderIdstringOrder submitted for cancellation.

Platform nuances​

info

Missing and terminal orders both return HTTP 400. Error text can name the terminal state, such as already Cancelled, so do not assume every terminal-order response contains not found or already terminal. Use GET Order Status when you need the current state.

info

Order ID note — The orderId returned when you place an order is the NT8-assigned GUID for that order. CrossTrade maintains internal handlers that can always resolve the original GUID you were given, even if NT8 or the broker reassigns the order ID internally. You can use the ID returned at placement time to cancel or look up an order at any point in its lifecycle.

WebSocket API​

This request can also be made over the WebSocket API. The account and orderId path parameters are passed inside args.

{
"action": "rpc",
"id": "my-request-id",
"api": "Cancel",
"args": {
"account": "Sim101",
"orderId": "492281fc515e431692da57d957cfebb6"
}
}