Skip to main content
POST
/
api
/
v4
/
order
/
collateral
/
limit
Collateral Limit Order
curl --request POST \
  --url https://whitebit.com/api/v4/order/collateral/limit \
  --header 'Content-Type: application/json' \
  --header 'X-TXC-APIKEY: <api-key>' \
  --data '
{
  "market": "<string>",
  "side": "buy",
  "amount": "<string>",
  "price": "<string>",
  "request": "<string>",
  "nonce": "<string>",
  "clientOrderId": "<string>",
  "stopLoss": "<string>",
  "takeProfit": "<string>",
  "postOnly": true,
  "ioc": true,
  "rpi": true,
  "positionSide": "long"
}
'
{
  "code": 123,
  "message": "<string>",
  "errors": {}
}

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 margin market. 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
​
amount
string
required

Amount of stock currency to buy or sell.

​
price
string
required

Price in money currency. Example: '9800'

​
request
string
required
​
nonce
string
required
​
clientOrderId
string

Identifier should be unique and contain letters, dashes, numbers, dots or underscores.

​
stopLoss
string

Stop loss price.

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

​
takeProfit
string

Take profit price.

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

​
postOnly
boolean

Orders are guaranteed to be the maker order when executed.

​
ioc
boolean

An immediate or cancel order (IOC) is an order that attempts to execute all or part immediately and then cancels any unfilled portion.

​
rpi
boolean

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

Response

Order created