Skip to main content
DELETE
TypeScript SDK

Authorizations

x-api-key
string
header
required

Path Parameters

orderId
string
required

Issued orderId.

Minimum string length: 1
Example:

"3f8b2c9a-2d18-4f7e-9c2a-1b6e1f0c8a4d"

Response

Cancel request accepted

orderId
string
required

Issued orderId.

Minimum string length: 1
Example:

"3f8b2c9a-2d18-4f7e-9c2a-1b6e1f0c8a4d"

status
enum<string>
required

Order lifecycle. pending: accepted; funding/signing, not yet resting. open: resting on the book, no fills yet. partial: partially filled. filled: fully filled. cancelled / failed: terminal.

Available options:
pending,
open,
partial,
filled,
cancelled,
failed
Example:

"open"

filledAmount
number
required

Total amount filled across all market orders, in USDC.

executionCost
number
required

All-in cost to execute this order, in USDC: venue fees plus collateral conversion slippage. Excludes gas (covered by ParlayX) and recoverable leftover collateral.

marketOrders
(MarketOrderResult · object | LimitOrderResult · object | StopOrderResult · object | StopLimitOrderResult · object | IcebergOrderResult · object)[]
required

Each market order in this order, in the order submitted — a type-discriminated entry (market/limit/stop/stop_limit). A conditional (stop/stop_limit) rests nothing until it fires, then this entry reflects the fills of the order it placed.

createdAt
string
required

ISO-8601 time the order was created.

updatedAt
string
required

ISO-8601 time the order was last updated.