Skip to main content
POST
/
portfolio
/
orders
/
{order_id}
/
decrease
Decrease Order
curl --request POST \
  --url https://external-api.kalshi.com/trade-api/v2/portfolio/orders/{order_id}/decrease \
  --header 'Content-Type: application/json' \
  --header 'KALSHI-ACCESS-KEY: <api-key>' \
  --header 'KALSHI-ACCESS-SIGNATURE: <api-key>' \
  --header 'KALSHI-ACCESS-TIMESTAMP: <api-key>' \
  --data '
{
  "subaccount": 0,
  "reduce_by": 2,
  "reduce_by_fp": "10.00",
  "reduce_to": 1,
  "reduce_to_fp": "10.00",
  "exchange_index": 0
}
'
{
  "order": {
    "order_id": "<string>",
    "user_id": "<string>",
    "client_order_id": "<string>",
    "ticker": "<string>",
    "yes_price_dollars": "0.5600",
    "no_price_dollars": "0.5600",
    "fill_count_fp": "10.00",
    "remaining_count_fp": "10.00",
    "initial_count_fp": "10.00",
    "taker_fill_cost_dollars": "0.5600",
    "maker_fill_cost_dollars": "0.5600",
    "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",
    "order_group_id": "<string>",
    "cancel_order_on_pause": true,
    "subaccount_number": 123,
    "exchange_index": 0
  }
}
Rate limit: 100 tokens per request. See GET /trade-api/v2/account/endpoint_costs for current non-default endpoint costs.

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
​
subaccount
integer
default:0

Optional subaccount number to use for this decrease (0 for primary, 1-63 for subaccounts)

Required range: x >= 0
​
reduce_by
integer

Number of contracts to reduce by (whole contracts only). Reduce-by may be provided via reduce_by or reduce_by_fp; if both provided they must match. Exactly one of reduce_by(/reduce_by_fp) or reduce_to(/reduce_to_fp) must be provided.

Required range: x >= 1
​
reduce_by_fp
string | null

String representation of the number of contracts to reduce by. Reduce-by may be provided via reduce_by or reduce_by_fp; if both provided they must match. Exactly one of reduce_by(/reduce_by_fp) or reduce_to(/reduce_to_fp) must be provided.

Example:

"10.00"

​
reduce_to
integer

Number of contracts to reduce to (whole contracts only). Reduce-to may be provided via reduce_to or reduce_to_fp; if both provided they must match. Exactly one of reduce_by(/reduce_by_fp) or reduce_to(/reduce_to_fp) must be provided.

Required range: x >= 0
​
reduce_to_fp
string | null

String representation of the number of contracts to reduce to. Reduce-to may be provided via reduce_to or reduce_to_fp; if both provided they must match. Exactly one of reduce_by(/reduce_by_fp) or reduce_to(/reduce_to_fp) 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
object
required