Skip to main content
POST
/
portfolio
/
orders
/
{order_id}
/
amend
Amend Order
curl --request POST \
  --url https://api.elections.kalshi.com/trade-api/v2/portfolio/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": "yes",
  "action": "buy",
  "client_order_id": "<string>",
  "updated_client_order_id": "<string>",
  "yes_price": 50,
  "no_price": 50,
  "yes_price_dollars": "0.5600",
  "no_price_dollars": "0.5600",
  "count": 2
}
'
{
  "old_order": {
    "order_id": "<string>",
    "user_id": "<string>",
    "client_order_id": "<string>",
    "ticker": "<string>",
    "side": "yes",
    "action": "buy",
    "type": "limit",
    "status": "resting",
    "yes_price": 123,
    "no_price": 123,
    "yes_price_dollars": "0.5600",
    "no_price_dollars": "0.5600",
    "fill_count": 123,
    "remaining_count": 123,
    "initial_count": 123,
    "taker_fees": 123,
    "maker_fees": 123,
    "taker_fill_cost": 123,
    "maker_fill_cost": 123,
    "taker_fill_cost_dollars": "0.5600",
    "maker_fill_cost_dollars": "0.5600",
    "queue_position": 123,
    "taker_fees_dollars": "0.5600",
    "maker_fees_dollars": "0.5600",
    "expiration_time": "2023-11-07T05:31:56Z",
    "created_time": "2023-11-07T05:31:56Z",
    "last_update_time": "2023-11-07T05:31:56Z",
    "self_trade_prevention_type": "taker_at_cross",
    "order_group_id": "<string>",
    "cancel_order_on_pause": true
  },
  "order": {
    "order_id": "<string>",
    "user_id": "<string>",
    "client_order_id": "<string>",
    "ticker": "<string>",
    "side": "yes",
    "action": "buy",
    "type": "limit",
    "status": "resting",
    "yes_price": 123,
    "no_price": 123,
    "yes_price_dollars": "0.5600",
    "no_price_dollars": "0.5600",
    "fill_count": 123,
    "remaining_count": 123,
    "initial_count": 123,
    "taker_fees": 123,
    "maker_fees": 123,
    "taker_fill_cost": 123,
    "maker_fill_cost": 123,
    "taker_fill_cost_dollars": "0.5600",
    "maker_fill_cost_dollars": "0.5600",
    "queue_position": 123,
    "taker_fees_dollars": "0.5600",
    "maker_fees_dollars": "0.5600",
    "expiration_time": "2023-11-07T05:31:56Z",
    "created_time": "2023-11-07T05:31:56Z",
    "last_update_time": "2023-11-07T05:31:56Z",
    "self_trade_prevention_type": "taker_at_cross",
    "order_group_id": "<string>",
    "cancel_order_on_pause": true
  }
}

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

Body

application/json
​
ticker
string
required

Market ticker

​
side
enum<string>
required

Side of the order

Available options:
yes,
no
​
action
enum<string>
required

Action of the order

Available options:
buy,
sell
​
client_order_id
string
required

The original client-specified order ID to be amended

​
updated_client_order_id
string
required

The new client-specified order ID after amendment

​
yes_price
integer

Updated yes price for the order in cents

Required range: 1 <= x <= 99
​
no_price
integer

Updated no price for the order in cents

Required range: 1 <= x <= 99
​
yes_price_dollars
string

Updated yes price for the order in fixed-point dollars. Exactly one of yes_price, no_price, yes_price_dollars, and no_price_dollars must be passed.

Example:

"0.5600"

​
no_price_dollars
string

Updated no price for the order in fixed-point dollars. Exactly one of yes_price, no_price, yes_price_dollars, and no_price_dollars must be passed.

Example:

"0.5600"

​
count
integer

Updated quantity for the order

Required range: x >= 1

Response

Order amended successfully

​
old_order
object
required

The order before amendment

​
order
object
required

The order after amendment