Skip to main content
DELETE
Cancel Order

Headers

PX-Key-Id
string
required

The key id issued for your signing keypair.

PX-Timestamp
string
required

Unix seconds at signing, valid within 30 seconds of the server clock.

PX-Signature
string
required

Ed25519 signature of the request

PX-Content-Sha256
string
required

Hex SHA-256 of the request body, or the SHA-256 of the empty string when there is no body.

Path Parameters

orderId
string<uuid>
required

Issued order id.

Example:

"abd80630-5c89-437f-980e-47936f518ec2"

Response

The order's current state. An order that is already cancelled, or that had already filled when the cancel arrived, is returned here with its terminal status rather than as an error.

orderId
string<uuid>
required

Issued order id.

Example:

"abd80630-5c89-437f-980e-47936f518ec2"

strikeId
string
required

The ProphetX strike to trade, which identifies both the market and the side.

Minimum string length: 1
Example:

"ab39fb9a7b4eb6a26d7e26f885c601c1"

price
string
required

Price in dollars per share, greater than 0 and less than 1, with at most six decimal places.

Example:

"0.413223"

quantity
number
required

Stake in account currency units.

Required range: x > 0
Example:

25

postOnly
boolean
required

Whether the order was placed as add-liquidity-only.

Example:

false

status
enum<string>
required

Order lifecycle status.

Available options:
PENDING,
SUBMITTED,
OPEN,
FILLED,
CANCELLED,
REJECTED
Example:

"OPEN"

venueOrderId
string | null
required

ProphetX order id, or null until the venue acknowledges the order.

Example:

"9f1a2b3c4d5e6f708192a3b4c5d6e7f8"

createdAt
string
required

Time the order was created, in ISO-8601.

Example:

"2026-08-29T12:00:00.000Z"

updatedAt
string
required

Time the order was last updated, in ISO-8601.

Example:

"2026-08-29T12:05:00.000Z"

filledQuantity
number | null
required

Total matched stake in dollars, from the fill ledger while the order is working and from the terminal summary once it closes, or null when no fills have been recorded.

Example:

10

queuePosition
string | null

Queue position is unavailable for this venue and is returned as null.

timeInForce
GoodTillCancelled · object

Requested execution policy when recorded with the order.

cancellationReason
enum<string>

Indicates cancellation initiated by the requested expiry.

Available options:
EXPIRED