Skip to main content
POST
Decrease Order (V2)

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-63 for subaccounts). Defaults to 0.

Body

application/json
reduce_by
string | null

String representation of the number of contracts to reduce by. Exactly one of reduce_by or reduce_to must be provided.

Example:

"10.00"

reduce_to
string | null

String representation of the number of contracts to reduce to. Exactly one of reduce_by or reduce_to must be provided.

Example:

"10.00"

exchange_index
integer
default:0

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

Example:

0

Response

Order decreased successfully

order_id
string
required
remaining_count
string
required

Number of contracts remaining after the decrease.

Example:

"10.00"

ts_ms
integer<int64>
required

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

client_order_id
string