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": "<string>",
  "request": "<string>",
  "nonce": "<string>",
  "orderId": 123,
  "clientOrderId": "<string>",
  "amount": "<string>",
  "total": "<string>",
  "price": "<string>",
  "activationPrice": "<string>"
}
'
{
  "orderId": 123,
  "clientOrderId": "<string>",
  "market": "<string>",
  "side": "<string>",
  "type": "<string>",
  "timestamp": 123,
  "dealMoney": "<string>",
  "dealStock": "<string>",
  "amount": "<string>",
  "left": "<string>",
  "dealFee": "<string>",
  "price": "<string>",
  "postOnly": true,
  "ioc": true,
  "status": "<string>",
  "stp": "<string>",
  "positionSide": "<string>",
  "rpi": true
}

Authorizations

​
X-TXC-APIKEY
string
header
required

API Key authentication for private endpoints.

Required headers:

  • X-TXC-APIKEY: Your 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

​
request
string
required
​
nonce
string
required
​
orderId
integer

Active order id. Required if clientOrderId is not set.

​
clientOrderId
string

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

​
amount
string

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

​
total
string

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

​
price
string

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

​
activationPrice
string

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

Response

Order modified successfully

​
orderId
integer

Order ID

​
clientOrderId
string

Custom client order ID; empty string if not specified

​
market
string

Deal market

​
side
string

Order side

​
type
string

Order type

​
timestamp
number

Timestamp of order creation

​
dealMoney
string

If order finished - amount in money currency that is finished

​
dealStock
string

If order finished - amount in stock currency that is finished

​
amount
string

Amount

​
left
string

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

​
dealFee
string

Fee in money that you pay if order is finished

​
price
string

Price

​
postOnly
boolean

PostOnly flag

​
ioc
boolean

IOC flag

​
status
string

Order status

​
stp
string

Self trade prevention mode

​
positionSide
string

Position side (for collateral orders)

​
rpi
boolean

RPI order flag - indicates whether Retail Price Improvement was enabled for this order

Example:

true