Collateral limit order

Place a collateral limit order to buy or sell at a specified price via the WhiteBIT V4 API.

POST /api/v4/order/collateral/limit

Collateral Limit Order

cURL

curl --request POST \
  --url https://whitebit.com/api/v4/order/collateral/limit \
  --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",
  "side": "buy",
  "amount": "0.01",
  "price": "40000",
  "postOnly": false,
  "ioc": false,
  "client_order_id": "order1987111",
  "stopLoss": "50000",
  "takeProfit": "30000",
  "positionSide": "LONG",
  "rpi": true,
  "request": "{{request}}",
  "nonce": "{{nonce}}"
}
'

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",
  "oto": {
    "otoId": 29457221,
    "stopLoss": "30000",
    "takeProfit": "50000"
  },
  "positionSide": "LONG",
  "rpi": true
}

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 margin market. Example: BTC_USDT

Example:

"BTC_USDT"

side · enum<string> · required

Order type. Variables: 'buy' / 'sell'. For open long position use buy, for short sell.

Available options: buy, sell

Example:

"buy"

amount · string · required

Amount of stock currency to buy or sell. Minimum and step values are market-dependent — query the market info endpoint for constraints.

Example:

"0.01"

price · string · required

Limit order price in money currency. Minimum price step is market-dependent — query the market info endpoint for constraints.

Example:

"40000"

request · string · required

Example:

"{{request}}"

nonce · string · required

Example:

"{{nonce}}"

client_order_id · string

Custom order identifier. Must be unique and contain only letters, numbers, dashes, dots, or underscores.

Example:

"order1987111"

stopLoss · string

Stop loss price.

When provided, the system creates an OTO order with a stop loss condition.

Example:

"50000"

takeProfit · string

Take profit price.

When provided, the system creates an OTO order with a take profit condition.

Example:

"30000"

postOnly · boolean · default: false

When true, guarantees the order executes as a maker order. The system rejects the order if it would immediately match as taker. Default: false.

Example:

false

ioc · boolean · default: false

When true, the order executes all or part immediately and cancels any unfilled portion. Cannot be combined with postOnly=true or rpi=true.

Example:

false

rpi · boolean · default: false

Enables Retail Price Improvement (RPI) mode.

RPI orders are post-only by design and cannot be used with ioc=true. The API returns error code 37 when both rpi=true and ioc=true are used.

Example:

true

positionSide · enum<string>

Defines the position direction when hedge mode is enabled. See positionSide

Available options: LONG, SHORT, BOTH

Example:

"LONG"

Response

200

application/json

Successful response - order created

order_id · integer

Unique order identifier

Example:

4180284841

client_order_id · string

Custom client order identifier. Empty string if not specified

Example:

"order1987111"

market · string

Market name

Example:

"BTC_USDT"

side · enum<string>

Order side

Available options: buy, sell

Example:

"buy"

type · string

Order type

Example:

"limit"

timestamp · number

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

Example:

1595792396.165973

deal_money · string

Amount in money currency that is finished

Example:

"0"

deal_stock · string

Amount in stock currency that is finished

Example:

"0"

amount · string

Order amount

Example:

"0.01"

left · string

Remaining amount that must be finished

Example:

"0.001"

deal_fee · string

Fee in money that is paid when order is finished

Example:

"0"

price · string

Order price

Example:

"40000"

postOnly · boolean

Post-only flag

Example:

false

ioc · boolean

Immediate or cancel flag

Example:

false

status · enum<string>

Order status

Available options: NEW, FILLED, PARTIALLY_FILLED, CANCELLED

Example:

"FILLED"

stp · string

Self trade prevention mode

Example:

"no"

oto · object

OTO order data when stopLoss or takeProfit is specified

Show child attributes

positionSide · enum<string>

Position side

Available options: LONG, SHORT, BOTH

Example:

"LONG"

rpi · boolean

Retail Price Improvement flag

Example:

true