v3

OpenAPI 3.0.02026-07-31103181312.8 KB

orders

Cancel Order (V2)

Endpoint for cancelling event-market orders using the V2 response shape. Returns {order_id, client_order_id, reduced_by} rather than a full order object.

delete/portfolio/events/orders/{order_id}

Path parameters

order_idstring required

Order ID

Query parameters

subaccountinteger

Subaccount number (0 for primary, 1-63 for subaccounts). Defaults to 0.

exchange_indexinteger

Identifier for an exchange shard. Defaults to 0 if unspecified.

market_tickerstring

Market ticker. Required when exchange_index is -1 (auto).

Response

Order cancelled successfully

order_idstring required

client_order_idstring

reduced_bystring required

Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.

ts_msinteger required

Matching engine timestamp at which the cancellation was processed, as Unix epoch milliseconds.

Example response

{
  "order_id": "3b23c1c7-f4ef-4f0d-8b9a-9e53c61f1a0d",
  "client_order_id": "8c35ecb3-328f-4f52-8c7c-0f4b9862f8d1",
  "reduced_by": "10.00",
  "ts_ms": 1715793660456
}