Skip to main content
POST
/
portfolio
/
events
/
orders
/
{order_id}
/
amend
Amend Order (V2)
curl --request POST \
  --url https://external-api.kalshi.com/trade-api/v2/portfolio/events/orders/{order_id}/amend \
  --header 'Content-Type: application/json' \
  --header 'KALSHI-ACCESS-KEY: <api-key>' \
  --header 'KALSHI-ACCESS-SIGNATURE: <api-key>' \
  --header 'KALSHI-ACCESS-TIMESTAMP: <api-key>' \
  --data '
{
  "ticker": "<string>",
  "side": "bid",
  "price": "0.5600",
  "count": "10.00",
  "client_order_id": "<string>",
  "updated_client_order_id": "<string>",
  "exchange_index": 0
}
'
{
  "order_id": "<string>",
  "ts_ms": 123,
  "client_order_id": "<string>",
  "remaining_count": "10.00",
  "fill_count": "10.00",
  "average_fill_price": "0.5600",
  "average_fee_paid": "0.5600"
}

Documentation Index

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

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

Authorizations

​
KALSHI-ACCESS-KEY
string
header
required

Your API key ID

​
KALSHI-ACCESS-SIGNATURE
string
header
required

RSA-PSS signature of the request

​
KALSHI-ACCESS-TIMESTAMP
string
header
required

Request timestamp in milliseconds

Path Parameters

​
order_id
string
required

Order ID

Query Parameters

​
subaccount
integer

Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0.

Body

application/json
​
ticker
string
required

Market ticker

​
side
enum<string>
required

Side of the order

Available options:
bid,
ask
​
price
string
required

Updated price for the order in fixed-point dollars.

Example:

"0.5600"

​
count
string
required

Updated total/max fillable count for the order. Set this to the order's already filled count plus the desired resting remaining count after the amend.

Example:

"10.00"

​
client_order_id
string

The original client-specified order ID to be amended

​
updated_client_order_id
string

The new client-specified order ID after amendment

​
exchange_index
integer
default:0

Identifier for an exchange shard. Defaults to 0 if unspecified. Note: currently only 0 supported.

Example:

0

Response

Order amended successfully

​
order_id
string
required
​
ts_ms
integer<int64>
required

Matching engine timestamp at which the amend was processed, as Unix epoch milliseconds.

​
client_order_id
string
​
remaining_count
string | null

Number of resting contracts remaining after the amend. This is the actual post-amend resting quantity, not the request's total/max fillable count. Only present when the amend caused a fill or changed the resting size.

Example:

"10.00"

​
fill_count
string | null

Number of contracts filled as a result of the amend crossing the book. Only present when fills occurred or remaining size changed.

Example:

"10.00"

​
average_fill_price
string | null

Volume-weighted average fill price for fills resulting from the amend. Only present when fills occurred.

Example:

"0.5600"

​
average_fee_paid
string | null

Volume-weighted average fee paid per contract for fills resulting from the amend. Only present when fills occurred.

Example:

"0.5600"