Skip to main content
PATCH
/
v1
/
orders
/
{order_id}
Edit Order
curl --request PATCH \
  --url https://api.rivermarkets.com/v1/orders/{order_id} \
  --header 'Content-Type: application/json' \
  --header 'X-River-Key-Id: <api-key>' \
  --header 'X-River-Signature: <api-key>' \
  --header 'X-River-Timestamp: <api-key>' \
  --data '
{
  "qty": 1,
  "price": 0.5
}
'
{
  "river_order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.rivermarkets.com/llms.txt

Use this file to discover all available pages before exploring further.

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.