API Reference

Place Algo Order

Rate Limit: 3 requests per 10 seconds

Place a new algo order, this api is asynchronous. Returning success only means that the request is successful. The final result needs to be confirmed through websocket subscription and order query.

Request

Field nameTypeNecessaryRemarks
clientOrderIdStringNCustomer defined order ID ,only support letters(a-z) and numbers(0-9)
algoOrderType StringYAlgo order types: TWAP, VWAP, TPSL, ATTACHED_TPSL
algoProviderStringNABEX; optional for TPSL and ATTACHED_TPSL
symStringYSym(unique identifier:Exchange_Business_Base_Counter.
Example:
If you want to place a SPOT order for the BTC/USDT trading pair on the Binance exchange, you can use a unique identifier like this: "BINANCE_SPOT_BTC_USDT" ;
If you want to place a PERPETUAL order for the BTC/USDT trading pair on the Binance exchange, you can use a unique identifier like this: "BINANCE_PERP_BTC_USDT" ;
)

Note that we currently only support the SPOT and PERPETUAL trade of Binance and OKX.
sideStringNSide(BUY, SELL)
limitPriceStringNLimit order price(Mandatory for limit order)
orderQtyStringNOrder quantity(Mandatory, unless spot market buy ) note: trading unit of OKX is the number of contracts/ trading unit of Binance is the number of coin
positionSideStringNPosition side, NONE/LONG/SHORT, default NONE. NONE stands for one-way mode.
reduceOnlyStringNReduce position orders only, must "true" or "false"

TP/SL

Field nameTypeNecessaryRemarks
conditionTypeStringYCONDITIONAL, OCO, ENTIRE_CLOSE_POSITION, PARTIAL_CLOSE_POSITION
conditionalTriggerPriceStringNConditional Order Trigger Price
conditionalTriggerPriceTypeStringNConditional Order Trigger Price Type:
LAST_PRICE, MARK_PRICE
conditionalPriceStringNLimit Price After Triggering Conditional Order ;
0 Indicates Market Price.
tpTriggerPriceStringNTake-profit trigger price.
tpTriggerTypeStringNTake-profit trigger price type:
LAST_PRICE, MARK_PRICE
The default is LAST_PRICE
tpPriceStringNTake-profit order price;
If the price is 0, take-profit will be executed at the market price.
slTriggerPriceStringNStop-loss trigger price
slTriggerTypeStringNStop-loss trigger price type:
LAST_PRICE, MARK_PRICE
The default is LAST_PRICE
slPriceStringNStop-loss order price;
If the price is 0, stop-loss will be executed at the market price.
orderTypeStringNOrder type(default LIMIT, support type enums:LIMIT,MARKET);
only for ATTACHED_TSPL
timeInForceStringNTimeInForce (default GTC, support type enums:GTC,IOC,FOK,GTX),
GTX = GTC + Post only;
only for ATTACHED_TSPL
quoteOrderQtyStringNOrder quote quantity, only use for spot market buy order;
only for ATTACHED_TSPL

TWAP/VWAP

Field nameTypeNecessaryRemarks
startTimeStringYStart time , unit of milisecond, must earlier than current time
endTimeStringY"End time , unit of milisecond, must later than start time,
and end time - start time < 24 hours"
intervalStringYUnit of second

Response

Field nameTypeRemarks
algoOrderIdStringAlgo order ID
clientOrderIdStringCustomer defined order ID
orderIdStringOrder ID; only for ATTACHED_TSPL
Language