Sign in

v26

latestOpenAPI 3.0.2raw.githubusercontent.com2024-10-0834042975.6 KB
Margin

Margin Account New OTOCO (TRADE)

Post a new OTOCO order for margin account:

  • An OTOCO (One-Triggers-the-Other-Cancel-the-Other) is an order list comprised of 3 orders
  • The first order is called the working order and must be LIMIT or LIMIT_MAKER. Initially, only the working order goes on the order book.
    • The behavior of the working order is the same as the OTO.
  • OTOCO has 2 pending orders (pending above and pending below), forming an OCO pair. The pending orders are only placed on the order book when the working order gets fully filled.
    • The rules of the pending above and pending below follow the same rules as the Order List OCO.
  • OTOCOs add 3 orders to the unfilled order count, EXCHANGE_MAX_NUM_ORDERS filter and MAX_NUM_ORDERS filter.

Weight(UID): 6

post/sapi/v1/margin/order/otoco

Query parameters

symbolstring required
Example:BNBUSDT

Trading symbol, e.g. BNBUSDT

isIsolated'TRUE' | 'FALSE'
  • TRUE - For isolated margin
  • FALSE - Default, not for isolated margin
sideEffectType'NO_SIDE_EFFECT' | 'MARGIN_BUY'

Default NO_SIDE_EFFECT

autoRepayAtCancelboolean
Example:true

Only when MARGIN_BUY order takes effect, true means that the debt generated by the order needs to be repay after the order is cancelled. The default is true

listClientOrderIdstring

Arbitrary unique ID among open order lists. Automatically generated if not sent. A new order list with the same listClientOrderId is accepted only when the previous one is filled or completely expired. listClientOrderId is distinct from the workingClientOrderId and the pendingClientOrderId.

newOrderRespType'ACK' | 'RESULT' | 'FULL'

Set the response JSON.

selfTradePreventionMode'EXPIRE_TAKER' | 'EXPIRE_MAKER' | 'EXPIRE_BOTH' | 'NONE'
Example:EXPIRE_TAKER

The allowed enums is dependent on what is configured on the symbol. The possible supported values are EXPIRE_TAKER, EXPIRE_MAKER, EXPIRE_BOTH, NONE.

workingType'LIMIT' | 'LIMIT_MAKER' required

Supported values: LIMIT,LIMIT_MAKER

workingSide'BUY' | 'SELL' required

BUY,SELL

workingClientOrderIdstring

Arbitrary unique ID among open orders for the working order. Automatically generated if not sent.

workingPricenumber double required
workingQuantitynumber double required

Sets the quantity for the working order.

workingIcebergQtynumber double required

This can only be used if workingTimeInForce is GTC.

workingTimeInForce'GTC' | 'IOC' | 'FOK'

GTC, IOC, FOK

pendingSide'BUY' | 'SELL' required

BUY,SELL

pendingQuantitynumber double required

Sets the quantity for the pending order.

pendingAboveType'LIMIT_MAKER' | 'STOP_LOSS' | 'STOP_LOSS_LIMIT' required

Supported values: LIMIT_MAKER, STOP_LOSS, and STOP_LOSS_LIMIT

pendingAboveClientOrderIdstring

Arbitrary unique ID among open orders for the pending above order. Automatically generated if not sent.

pendingAbovePricenumber double
pendingAboveStopPricenumber double
pendingAboveTrailingDeltanumber double
pendingAboveIcebergQtynumber double

This can only be used if pendingAboveTimeInForce is GTC.

pendingAboveTimeInForce'GTC' | 'IOC' | 'FOK'
pendingBelowType'LIMIT_MAKER' | 'STOP_LOSS' | 'STOP_LOSS_LIMIT'

Supported values: LIMIT_MAKER, STOP_LOSS, and STOP_LOSS_LIMIT

pendingBelowClientOrderIdstring

Arbitrary unique ID among open orders for the pending below order. Automatically generated if not sent.

pendingBelowPricenumber double
pendingBelowStopPricenumber double
pendingBelowTrailingDeltanumber double
pendingBelowIcebergQtynumber double

This can only be used if pendingBelowTimeInForce is GTC.

pendingBelowTimeInForce'GTC' | 'IOC' | 'FOK'
timestampinteger required

UTC timestamp in ms

signaturestring required

Signature

Response

OTOCO order

orderListIdinteger required
contingencyTypestring required
listStatusTypestring required
listOrderStatusstring required
listClientOrderIdstring required
transactionTimeinteger required
symbolstring required
isIsolatedboolean required

Example response

{
  "orderListId": 13551,
  "contingencyType": "OTOCO",
  "listStatusType": "EXEC_STARTED",
  "listOrderStatus": "EXECUTING",
  "listClientOrderId": "u2AUo48LLef5qVenRtwJZy",
  "transactionTime": 1725521881300,
  "symbol": "BNBUSDT"
}