Modify order

Modify the price or amount of an existing open spot order via the WhiteBIT V4 API.

POST /api/v4/order/modify

Modify order

cURL

curl --request POST \
  --url https://whitebit.com/api/v4/order/modify \
  --header 'Content-Type: application/json' \
  --header 'X-TXC-APIKEY: <api-key>' \
  --header 'X-TXC-PAYLOAD: <api-key>' \
  --header 'X-TXC-SIGNATURE: <api-key>' \
  --data '
{
  "market": "BTC_USDT",
  "request": "{{request}}",
  "nonce": "{{nonce}}",
  "order_id": 4180284841,
  "client_order_id": "order1987111",
  "amount": "0.001",
  "total": "100",
  "price": "9800",
  "activationPrice": "10000"
}
'

200

{
  "order_id": 4180284841,
  "client_order_id": "order1987111",
  "market": "BTC_USDT",
  "side": "buy",
  "type": "limit",
  "timestamp": 1595792396.165973,
  "deal_money": "0",
  "deal_stock": "0",
  "amount": "0.01",
  "left": "0.001",
  "deal_fee": "0",
  "price": "40000",
  "postOnly": false,
  "ioc": false,
  "status": "FILLED",
  "stp": "no",
  "positionSide": "LONG",
  "rpi": true,
  "reduceOnly": false,
  "activated": 0,
  "activationCondition": "lte",
  "activation_price": "40000"
}

Authorizations

X-TXC-APIKEY · string · header · required

The public WhiteBIT API key.

X-TXC-PAYLOAD · string · header · required

Base64-encoded JSON request body.

X-TXC-SIGNATURE · string · header · required

HMAC-SHA512 signature of the payload, hex-encoded. Computed as hex(HMAC-SHA512(payload, api_secret)).

Body

application/json

market · string · required

Available market. Example: BTC_USDT

Example:

"BTC_USDT"

request · string · required

Example:

"{{request}}"

nonce · string · required

Example:

"{{nonce}}"

order_id · integer

Active order id. Required if client_order_id is not set.

Example:

4180284841

client_order_id · string

Identifier should be unique and contain letters, dashes, numbers, dots or underscores. Required if order_id is not set.

Example:

"order1987111"

amount · string

Amount of stock currency to buy or sell. Example: '0.001' or 0.001

Example:

"0.001"

total · string

Total of money currency to buy or sell. Example: '0.001' or 0.001

Example:

"100"

price · string

Price in money currency. Example: '9800' or 9800

Example:

"9800"

activationPrice · string

Activation price in money currency. Example: '10000' or 10000

Example:

"10000"

Response

200

application/json

Order modified successfully

order_id · integer

Unique identifier assigned to the order by the matching engine.

Example:

4180284841

client_order_id · string

Custom client order identifier supplied in the request. Returns an empty string when not specified.

Example:

"order1987111"

market · string

Trading pair for the order. Format: BASE_QUOTE (e.g., BTC_USDT).

Example:

"BTC_USDT"

side · string

Order side. Possible values: buy, sell.

Example:

"buy"

type · string

Order type. Possible values: limit, market, stock market, stop limit, stop market.

Example:

"limit"

timestamp · number

Unix timestamp in seconds (UTC) of order creation, with microsecond precision.

Example:

1595792396.165973

deal_money · string

Filled amount in quote currency. Returns "0" while the order remains unfilled.

Example:

"0"

deal_stock · string

Filled amount in base currency. Returns "0" while the order remains unfilled.

Example:

"0"

amount · string

Order quantity in base currency for limit and stop-limit orders, or in quote currency for buy market orders.

Example:

"0.01"

left · string

Remaining unfilled quantity. Equals amount for new orders and "0" for fully filled orders.

Example:

"0.001"

deal_fee · string

Cumulative trading fee charged for filled portions, denominated in the fee asset.

Example:

"0"

price · string

Limit price per unit in quote currency. Returns "0" for market orders.

Example:

"40000"

postOnly · boolean

Post-only flag. When true, the order executes only as a maker order and is rejected if it would match immediately. Default: false.

Example:

false

ioc · boolean

Immediate-or-cancel flag. When true, the order executes available quantity immediately and cancels the unfilled remainder. Default: false.

Example:

false

status · string

Order lifecycle status. NEW — accepted, not yet matched. FILLED — fully executed. CANCELED — canceled before execution. PARTIAL_FILLED — partially executed, remainder still active. PARTIAL_CANCELED — partially filled, remainder canceled. CANCELED_TAKER_BAND — partially filled up to the taker band limit, remainder canceled to protect against excessive order book slippage. AUTO_CANCELED_REDUCE_ONLY — pending reduce-only order auto-canceled because the associated position was closed.

Example:

"FILLED"

stp · string

Self-trade prevention mode. Possible values: no, cancel_both, cancel_new, cancel_old. Default: no.

Example:

"no"

positionSide · string

Position side (for collateral orders)

Example:

"LONG"

rpi · boolean

Indicates Retail Price Improvement (RPI) mode for the order.

Example:

true

reduceOnly · boolean

Reduce-only flag. When true, the order can only reduce or close an existing position. See reduce-only.

Example:

false

activated · integer

Activation status of the stop order. 0 = not yet triggered (waiting for the activation_price condition to be met). 1 = triggered (the stop condition has been met and the order is now active).

Example:

0

activationCondition · enum<string>

Condition that triggers the stop order. "lte" = activate when the market price falls to or below activation_price. "gte" = activate when the market price rises to or above activation_price.

Available options: lte, gte

Example:

"lte"

activation_price · string

The trigger price for the stop order. Always equals the activation_price value submitted in the request.

Example:

"40000"