Skip to main content
PATCH
Edit Order

Authorizations

X-River-Key-Id
string
header
required

UUID of your API key (from Settings → API Keys).

X-River-Timestamp
string
header
required

Current unix seconds. Must be within 30s of server time.

X-River-Signature
string
header
required

Base64 Ed25519 signature over the canonical request: METHOD\nPATH\nSORTED_QUERY\nTIMESTAMP\nSHA256(body) hex. See /api-reference/authentication for the full recipe.

Path Parameters

order_id
string<uuid>
required

Body

application/json

Schema for editing (amending) an existing simple limit order.

qty is the TOTAL order quantity (not remaining) — matches Kalshi's amend semantics. At least one of qty or price must be provided.

qty
number | null

New total order quantity

Required range: x > 0
price
number | null

New limit price (between 0 and 1)

Required range: 0 < x < 1

Response

Successful Response

Schema for order edit response.

river_order_id
string<uuid>
required

Unique order identifier

status
string
required

Always PENDING_AMEND. Final status (RESTING on success, REJECTED on failure) is delivered via the orders WS.