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.
SDK Links
Request
| HTTP Method | POST |
| HTTP URL | /v1/trade/order/multileg |
Parameters
Content-Type: application/json; charset=utf-8
| Name | Type | Required | Description |
|---|---|---|---|
| side | string | YES | Order Side Enum Value: BuySell |
| order_type | string | YES | Order Type |
| submitted_price | string | NO | Submitted price, example: 1.5Required for limit order types such as LO |
| submitted_quantity | string | YES | Submitted quantity (number of combinations), example: 1 |
| strategy | string | YES | Multi-leg strategy Enum Value: CoveredCall - Covered stockCoveredPut - Covered stockVerticalCallSpread - Vertical spreadVerticalPutSpread - Vertical spreadCollar - CollarStraddle - StraddleStrangle - Strangle |
| legs | object[] | YES | Legs of the combination order |
| ∟ symbol | string | YES | Option symbol, use ticker.region format, example: QQQ260731C764000.US |
| ∟ ratio_quantity | string | YES | Leg ratio quantity, example: 1 |
| remark | string | NO | Remark (Maximum 255 characters) |
| client_request_id | string | NO | Client 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
| Status | Description | Schema |
|---|---|---|
| 200 | The submission was successful and the order was commissioned. | None |
| 400 | The submit was rejected with an incorrect request parameter. | None |