Skip to main content
POST
/
v3
/
trade
/
algoOrder
cURL
curl --request POST \
  --url https://api.woox.io/v3/trade/algoOrder \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-api-signature: <x-api-signature>' \
  --header 'x-api-timestamp: <x-api-timestamp>' \
  --data '
{
  "symbol": "<string>",
  "algoType": "<string>",
  "clientAlgoOrderId": 123,
  "algoOrderTag": "<string>",
  "side": "<string>",
  "positionSide": "<string>",
  "quantity": "<string>",
  "visibleQuantity": "<string>",
  "marginMode": "<string>",
  "triggerPrice": "<string>",
  "triggerPriceType": "<string>",
  "type": "<string>",
  "price": "<string>",
  "reduceOnly": true
}
'
// STOP, OCO, TRAILING_STOP
{
  "success": true,
  "data": {
    "rows": [
      {
        "algoType": "string",
        "clientAlgoOrderId": 0,
        "algoOrderId": 0,
        "quantity": "0"
      }
    ]
  },
  "timestamp": 1676283560233
}
// POSITIONAL_TP_SL, TP_SL
{
    "success": true,
    "data": {
        "rows": [
            {
                "algoOrderId": 432132,
                "clientAlgoOrderId": 0,
                "algoType": "TAKE_PROFIT",
                "quantity": "0"
            },
            {
                "algoOrderId": 432133,
                "clientAlgoOrderId": 0,
                "algoType": "STOP_LOSS",
                "quantity": "0"
            },
            {
                "algoOrderId": 432131,
                "clientAlgoOrderId": 0,
                "algoType": "string",
                "quantity": "0"
            }
        ]
    },
    "timestamp": 1676283560233
}
// BRACKET, STOP_BRACKET
{
    "success": true,
    "data": {
        "rows": [
            {
                "algoOrderId": 432132,
                "clientAlgoOrderId": 0,
                "algoType": "TAKE_PROFIT",
                "quantity": "0"
            },
            {
                "algoOrderId": 432133,
                "clientAlgoOrderId": 0,
                "algoType": "STOP_LOSS",
                "quantity": "0"
            },
            {
                "orderId": 432131,
                "clientAlgoOrderId": 0,
                "algoType": "POSITIONAL_TP_SL",
                "quantity": "0"
            },
            {
                "algoOrderId": 432130,
                "clientAlgoOrderId": 0,
                "algoType": "BRACKET",
                "quantity": "10"
            }
        ]
    },
    "timestamp": 1676283560233
}
Limit: 2 requests per 1 second per symbol
Supported algo orders include STOP, OCO, TRAILING_STOP, POSITIONAL_TP_SL, TP_SL, BRACKET and STOP_BRACKET orders. clientAlgoOrderId behavior: needs to be unique among open algo orders. Orders with the same clientAlgoOrderId can be accepted only when the previous one is completed, otherwise the order would be rejected. Note that it’s treated separately from the clientOrderId for ordinary orders. visibleQuantity behavior: it sets the maximum quantity to be shown on orderbook. By default, it is equal to quantity. If it’s set to 0, the order would be hidden from the orderbook. Open algo order limit:
  • a maximum of 100 open algo orders is allowed on a per instrument basis
  • a maximum of 10 open TP_SL orders are permitted per instrument - this is inclusive of the TP_SL orders that are still attached to BRACKET or STOP_BRACKET order
  • a maximum of 1 open POSITIONAL_TP_SL is allowed per instrument per side - when a second POSITIONAL_TP_SL order gets activated that’s associated with a BRACKET or a STOP_BRACKET order, this new POSITIONAL_TP_SL order will replace the previous POSITIONAL_TP_SL order 
// STOP, OCO, TRAILING_STOP
{
  "success": true,
  "data": {
    "rows": [
      {
        "algoType": "string",
        "clientAlgoOrderId": 0,
        "algoOrderId": 0,
        "quantity": "0"
      }
    ]
  },
  "timestamp": 1676283560233
}
// POSITIONAL_TP_SL, TP_SL
{
    "success": true,
    "data": {
        "rows": [
            {
                "algoOrderId": 432132,
                "clientAlgoOrderId": 0,
                "algoType": "TAKE_PROFIT",
                "quantity": "0"
            },
            {
                "algoOrderId": 432133,
                "clientAlgoOrderId": 0,
                "algoType": "STOP_LOSS",
                "quantity": "0"
            },
            {
                "algoOrderId": 432131,
                "clientAlgoOrderId": 0,
                "algoType": "string",
                "quantity": "0"
            }
        ]
    },
    "timestamp": 1676283560233
}
// BRACKET, STOP_BRACKET
{
    "success": true,
    "data": {
        "rows": [
            {
                "algoOrderId": 432132,
                "clientAlgoOrderId": 0,
                "algoType": "TAKE_PROFIT",
                "quantity": "0"
            },
            {
                "algoOrderId": 432133,
                "clientAlgoOrderId": 0,
                "algoType": "STOP_LOSS",
                "quantity": "0"
            },
            {
                "orderId": 432131,
                "clientAlgoOrderId": 0,
                "algoType": "POSITIONAL_TP_SL",
                "quantity": "0"
            },
            {
                "algoOrderId": 432130,
                "clientAlgoOrderId": 0,
                "algoType": "BRACKET",
                "quantity": "10"
            }
        ]
    },
    "timestamp": 1676283560233
}

Headers

​
x-api-key
string
required

api-key

Example:

"abcdef123456"

​
x-api-signature
string
required

api-signature

Example:

"signaturestring"

​
x-api-timestamp
string
required

api-timestamp

Example:

"1718943200000"

Body

application/json
​
symbol
string
required

Symbol name

​
algoType
string
required

STOP: stop market / stop limit order

​
clientAlgoOrderId
integer

Client algo order Id as assigned by the user

​
algoOrderTag
string

An optional tag for this order, max string length: 64

​
side
string

BUY/SELL, not required for POSITIONAL_TP_SL or TP_SL order

​
positionSide
string

BOTH for one way mode; LONG or SHORT for hedge mode; Only applicable to perpetual instruments

​
quantity
string

Order quantity, not required for POSITIONAL_TP_SL order

​
visibleQuantity
string

The order quantity shown on orderbook; for POSITIONAL_TP_SL order, visibleQuantity applies directly to the child orders

​
marginMode
string

CROSS / ISOLATED

​
triggerPrice
string

Only support LIMIT

​
triggerPriceType
string

Trigger price type, currently only support MARKET_PRICE (i.e. last price)

​
type
string

Trigger price, only support LIMIT

​
price
string

Order price, only applicable to LIMIT type

​
reduceOnly
boolean

Only applicable to perpetual instruments; whether the order can only reduce in position size; valid options are true/false

Response

200 - application/json
​
success
boolean

true

​
timestamp
integer

timestamp

​
data
object