> ## Documentation Index
> Fetch the complete documentation index at: https://docs.whitebit.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Collateral limit order
> Place a collateral limit order to buy or sell at a specified price via the WhiteBIT V4 API.
export const RelatedResources = ({children}) => {
const ref = useRef(null);
const [visible, setVisible] = useState(false);
useEffect(() => {
if (!ref.current) return;
const el = ref.current;
if (el.parentElement) {
el.parentElement.appendChild(el);
}
setVisible(true);
}, []);
return
Related resources
{children}
;
};
* [Collateral market order](/api-reference/collateral-trading/collateral-market-order) — Place a collateral market order
* [Collateral stop-limit order](/api-reference/collateral-trading/collateral-stop-limit-order) — Place a collateral stop-limit order
* [Collateral bulk limit order](/api-reference/collateral-trading/collateral-bulk-limit-order) — Place multiple limit orders in a single request
* [Create collateral OCO order](/api-reference/collateral-trading/create-collateral-oco-order) — Create a combined limit and stop-limit order
* [Cancel conditional order](/api-reference/collateral-trading/cancel-conditional-order) — Cancel an active conditional order
## OpenAPI
````yaml /openapi/private/http-trade-v4.yaml POST /api/v4/order/collateral/limit
openapi: 3.0.3
info:
title: Private HTTP API V4 - Collateral Trading
description: |
WhiteBIT Private HTTP API V4 for collateral/margin trading operations.
Base URL: https://whitebit.com
All endpoints return time in Unix-time format.
All endpoints return either a JSON object or array.
For receiving responses from API calls please use http method POST.
Authentication required for all endpoints.
version: 4.0.0
license:
name: WhiteBIT Terms of Service
url: https://whitebit.com/terms
servers:
- url: https://whitebit.com
description: WhiteBIT Global Server
- url: https://whitebit.eu
description: WhiteBIT EU Server
security:
- ApiKeyAuth: []
PayloadAuth: []
SignatureAuth: []
tags:
- name: Collateral Trading
description: Endpoints for collateral/margin trading operations
- name: Spot Trading
description: Endpoints for spot trading operations
- name: Market Fee
description: Endpoints for querying trading fees
paths:
/api/v4/order/collateral/limit:
post:
tags:
- Collateral Trading
summary: Collateral Limit Order
description: >
The endpoint creates a [limit order](/glossary#limit-order) using
[collateral balance](/glossary#balance-collateral). The order executes
at the specified price or better. Use `buy` to open or increase a long
position and `sell` to open or increase a short position. To close a
position, place an opposite-side order matching the position amount.
**Order validation rules** (per-market, from `GET
/api/v4/public/markets`):
- `amount` must have at most `stockPrec` decimal places
- `price` must have at most `moneyPrec` decimal places
- `amount` must be ≥ `minAmount`
- `amount × price` must be ≥ `minTotal`
- `amount × price` must be ≤ `maxTotal` (when `maxTotal` is not `"0"`)
Rate limit: 10000 requests/10 sec.
For open long position use **buy**, for short **sell**. To close current
position, place opposite order with current position amount.
- RPI orders are post-only by design and cannot be used with the IOC flag. The API returns error code `40` when both `rpi=true` and `ioc=true` are used.
- `30` - default validation error code. Also returned when `reduceOnly=true` is combined with `stopLoss` or `takeProfit`
- `31` - market validation failed
- `32` - amount validation failed
- `33` - price validation failed
- `36` - clientOrderId validation failed
- `37` - `ioc=true` cannot be combined with `postOnly=true`
- `40` - `ioc=true` cannot be combined with `rpi=true`
- `43` - `rpi=true` is not allowed for the account
- `10` - insufficient balance to place the order
- `111` - resulting position would exceed the market maximum
- `112` - pending orders value would exceed the allowed maximum
- `113` - position side cannot be changed while open positions or orders exist
- `114` - hedge mode position side does not match (sent `BOTH` or omitted `positionSide` in hedge mode, or sent `LONG`/`SHORT` in one-way mode)
- `115` - order would open a position in the opposite direction (one-way mode)
- `116` - reduce-only validation failed (no position exists or order side matches position direction)
operationId: createCollateralLimitOrder
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- market
- side
- amount
- price
- request
- nonce
properties:
market:
type: string
description: >-
Available margin [market](/glossary#market). Example:
BTC_USDT
example: BTC_USDT
side:
type: string
enum:
- buy
- sell
description: >-
Order type. Variables: 'buy' / 'sell'. For open long
position use **buy**, for short **sell**.
example: buy
amount:
type: string
description: >-
Amount of [stock](/glossary#stock) currency to buy or sell.
Minimum and step values are market-dependent — query the
[market info](/api-reference/market-data/market-info)
endpoint for constraints.
example: '0.01'
price:
type: string
description: >-
Limit order price in [money](/glossary#money) currency.
Minimum price step is market-dependent — query the [market
info](/api-reference/market-data/market-info) endpoint for
constraints.
example: '40000'
clientOrderId:
type: string
description: >-
Custom order identifier. Must be unique and contain only
letters, numbers, dashes, dots, or underscores.
example: order1987111
stopLoss:
type: string
description: >
Stop loss price.
When provided, the system creates an
[OTO](/glossary#one-triggers-the-other-oto) order with a
stop loss condition.
example: '50000'
takeProfit:
type: string
description: >
Take profit price.
When provided, the system creates an
[OTO](/glossary#one-triggers-the-other-oto) order with a
take profit condition.
example: '30000'
postOnly:
type: boolean
default: false
description: >-
When `true`, guarantees the order executes as a
[maker](/glossary#maker) order. The system rejects the order
if it would immediately match as taker. Default: `false`.
example: false
ioc:
type: boolean
default: false
description: >-
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:
type: boolean
default: false
description: >
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 `40` when both
`rpi=true` and `ioc=true` are used.
example: true
positionSide:
type: string
enum:
- LONG
- SHORT
- BOTH
description: >
Position direction. Optional at the request layer but
functionally required when hedge mode is enabled. See
[positionSide](/glossary#position-side).
- **One-way mode** (default account mode): the field is
ignored. Orders always use `BOTH`, and the response returns
`positionSide: "BOTH"` whether the field is sent or omitted.
- **Hedge mode**: the field MUST be `LONG` or `SHORT`.
Sending `BOTH`, omitting the field, or sending a value that
does not match the account's mode causes the trade service
to reject the order with error code `114` (`Hedge mode
position side does not match`).
example: LONG
reduceOnly:
type: boolean
default: false
description: >-
When `true`, the order can only reduce or close an existing
position — the order cannot increase the position or open a
new one. If the order amount exceeds the current position
size, the system reduces the order to match — the response
returns the adjusted amount. Cannot be combined with
`stopLoss` or `takeProfit`. The API returns error code `116`
if no open position exists or the order side matches the
position direction. See
[reduce-only](/glossary#reduce-only).
example: false
request:
type: string
example: '{{request}}'
nonce:
type: string
example: '{{nonce}}'
example:
market: BTC_USDT
side: buy
amount: '0.01'
price: '40000'
postOnly: false
ioc: false
clientOrderId: order1987111
stopLoss: '50000'
takeProfit: '30000'
positionSide: LONG
rpi: true
reduceOnly: false
request: '{{request}}'
nonce: '{{nonce}}'
responses:
'200':
description: Successful response - order created
content:
application/json:
schema:
type: object
properties:
orderId:
type: integer
description: Unique order identifier
example: 4180284841
clientOrderId:
type: string
description: >-
Custom client order identifier. Empty string if not
specified
example: order1987111
market:
type: string
description: Market name
example: BTC_USDT
side:
type: string
description: Order side
enum:
- buy
- sell
example: buy
type:
type: string
description: Order type
example: limit
timestamp:
type: number
description: >-
Unix timestamp in seconds (UTC) of order creation, with
microsecond precision.
example: 1595792396.165973
dealMoney:
type: string
description: Amount in money currency that is finished
example: '0'
dealStock:
type: string
description: Amount in stock currency that is finished
example: '0'
amount:
type: string
description: Order amount
example: '0.01'
left:
type: string
description: Remaining amount that must be finished
example: '0.001'
dealFee:
type: string
description: Fee in money that is paid when order is finished
example: '0'
price:
type: string
description: Order price
example: '40000'
postOnly:
type: boolean
description: Post-only flag
example: false
ioc:
type: boolean
description: Immediate or cancel flag
example: false
status:
$ref: '#/components/schemas/ActiveOrderStatus'
stp:
type: string
description: Self trade prevention mode
example: 'no'
oto:
type: object
description: OTO order data when stopLoss or takeProfit is specified
nullable: true
properties:
otoId:
type: integer
description: OTO order identifier
example: 29457221
stopLoss:
type: string
description: Stop loss order price
example: '30000'
takeProfit:
type: string
description: Take profit order price
example: '50000'
positionSide:
type: string
description: Position side
enum:
- LONG
- SHORT
- BOTH
example: LONG
rpi:
type: boolean
description: Retail Price Improvement flag
example: true
reduceOnly:
type: boolean
description: Reduce-only flag
example: false
example:
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'
oto:
otoId: 29457221
stopLoss: '30000'
takeProfit: '50000'
positionSide: LONG
rpi: true
reduceOnly: false
'422':
description: Inner validation failed
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'503':
description: Service temporarily unavailable
security:
- ApiKeyAuth: []
PayloadAuth: []
SignatureAuth: []
components:
schemas:
ActiveOrderStatus:
type: string
description: >-
Order status. `NEW` — accepted, not yet matched. `FILLED` — fully
executed. `PARTIALLY_FILLED` — partially executed, remainder still
active. `CANCELLED` — canceled before full execution.
enum:
- NEW
- FILLED
- PARTIALLY_FILLED
- CANCELLED
example: FILLED
ErrorResponse:
type: object
properties:
code:
type: integer
description: Error code
example: 30
message:
type: string
description: Error message
example: Validation failed
errors:
type: object
additionalProperties:
type: array
items:
type: string
description: Detailed error information
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: X-TXC-APIKEY
description: The public WhiteBIT API key.
PayloadAuth:
type: apiKey
in: header
name: X-TXC-PAYLOAD
description: Base64-encoded JSON request body.
SignatureAuth:
type: apiKey
in: header
name: X-TXC-SIGNATURE
description: >-
HMAC-SHA512 signature of the payload, hex-encoded. Computed as
hex(HMAC-SHA512(payload, api_secret)).
````