Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

User session token

Body

application/json

Identifier of the order to replace; either oid (server order id) or cid (client order id).

oid
string
required

Strong type for Order IDs to prevent mixing with other string values

Order IDs are ULIDs with a prefix:

  • Regular orders: O-
  • Liquidation orders: L-
aid
string | null

Optional account ID, selecting which account's cid namespace the reference resolves against. Only meaningful when the order is given by cid — a cid is unique per account, not globally — and superfluous when oid is supplied (server order ids are globally unique). If omitted, the account is inferred from the connection: the user's default account, or the session account for an account-scoped session.

p
string | null

New price for the replacement order (optional, inherits from original if not provided)

po
boolean | null

Whether the replacement order is post-only (optional, inherits from original if not provided)

q
integer<int64> | null

New quantity for the replacement order (optional, inherits from original if not provided)

Required range: x >= 0
tif
string | null

New time in force for the replacement order (optional, inherits from original if not provided)

Response

Order replaced successfully

oid
string
required

Order ID of the new replacement order; e.g. "ORD-1234567890"