Skip to Content

Submit Multi-leg Order

This API is used to submit a multi-leg option combination order (such as vertical spreads, straddles, strangles, collars, etc.). All legs are submitted together as a single strategy order.

Request

HTTP MethodPOST
HTTP URL/v1/trade/order/multileg

Parameters

Content-Type: application/json; charset=utf-8

NameTypeRequiredDescription
sidestringYESOrder Side

Enum Value:
Buy
Sell
order_typestringYESOrder Type
submitted_pricestringNOSubmitted price, example: 1.5

Required for limit order types such as LO
submitted_quantitystringYESSubmitted quantity (number of combinations), example: 1
strategystringYESMulti-leg strategy

Enum Value:
CoveredCall - Covered stock
CoveredPut - Covered stock
VerticalCallSpread - Vertical spread
VerticalPutSpread - Vertical spread
Collar - Collar
Straddle - Straddle
Strangle - Strangle
legsobject[]YESLegs of the combination order
∟ symbolstringYESOption symbol, use ticker.region format, example: QQQ260731C764000.US
∟ ratio_quantitystringYESLeg ratio quantity, example: 1
remarkstringNORemark (Maximum 255 characters)
client_request_idstringNOClient request ID, used for idempotency (Maximum 64 characters)

Request Example

Response

Response Headers

  • Content-Type: application/json

Response Example

json
{
  "code": 0,
  "message": "success",
  "data": {
    "order_id": "683615454870679600"
  }
}

Response Status

StatusDescriptionSchema
200The submission was successful and the order was commissioned.None
400The submit was rejected with an incorrect request parameter.None