Skip to main content
POST
/
api
/
v4
/
order
/
modify
Modify order
curl --request POST \
  --url https://whitebit.com/api/v4/order/modify \
  --header 'Content-Type: application/json' \
  --header 'X-TXC-APIKEY: <api-key>' \
  --data '
{
  "market": "BTC_USDT",
  "request": "{{request}}",
  "nonce": "{{nonce}}",
  "orderId": 4180284841,
  "clientOrderId": "order1987111",
  "amount": "0.001",
  "total": "100",
  "price": "9800",
  "activationPrice": "10000"
}
'
{
  "orderId": 4180284841,
  "clientOrderId": "order1987111",
  "market": "BTC_USDT",
  "side": "buy",
  "type": "limit",
  "timestamp": 1595792396.165973,
  "dealMoney": "0",
  "dealStock": "0",
  "amount": "0.01",
  "left": "0.001",
  "dealFee": "0",
  "price": "40000",
  "postOnly": false,
  "ioc": false,
  "status": "FILLED",
  "stp": "no",
  "positionSide": "LONG",
  "rpi": true
}

Authorizations

​
X-TXC-APIKEY
string
header
required

API Key authentication for private endpoints.

Required headers:

  • X-TXC-APIKEY: API key
  • X-TXC-PAYLOAD: Base64 encoded JSON payload
  • X-TXC-SIGNATURE: HMAC SHA512 signature

Body

application/json
​
market
string
required

Available market. Example: BTC_USDT

Example:

"BTC_USDT"

​
request
string
required
Example:

"{{request}}"

​
nonce
string
required
Example:

"{{nonce}}"

​
orderId
integer

Active order id. Required if clientOrderId is not set.

Example:

4180284841

​
clientOrderId
string

Identifier should be unique and contain letters, dashes, numbers, dots or underscores. Required if orderId 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

Order modified successfully

​
orderId
integer

Order ID

Example:

4180284841

​
clientOrderId
string

Custom client order ID; empty string if not specified

Example:

"order1987111"

​
market
string

Deal market

Example:

"BTC_USDT"

​
side
string

Order side

Example:

"buy"

​
type
string

Order type

Example:

"limit"

​
timestamp
number

Timestamp of order creation

Example:

1595792396.165973

​
dealMoney
string

If order finished - amount in money currency that is finished

Example:

"0"

​
dealStock
string

If order finished - amount in stock currency that is finished

Example:

"0"

​
amount
string

Amount

Example:

"0.01"

​
left
string

If order not finished - rest of the amount that must be finished

Example:

"0.001"

​
dealFee
string

Fee in money currency when order is filled

Example:

"0"

​
price
string

Price

Example:

"40000"

​
postOnly
boolean

PostOnly flag

Example:

false

​
ioc
boolean

IOC flag

Example:

false

​
status
string

Order status

Example:

"FILLED"

​
stp
string

Self trade prevention mode

Example:

"no"

​
positionSide
string

Position side (for collateral orders)

Example:

"LONG"

​
rpi
boolean

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

Example:

true