Trade
Authorization
Signed mode: every request is signed with your App Key/Secret. Header set:
| Name | Type | Required | Description |
|---|---|---|---|
Authorization | string · header | Required | The account Access Token from the OpenAPI dashboard — passed as the raw token (no Bearer prefix) and included in the signature calculation. |
X-Api-Key | string · header | Required | Your App Key. |
X-Timestamp | string · header | Required | Request timestamp in seconds (Unix epoch). |
X-Api-Signature | string · header | Required | HMAC-SHA256 signature. Format: HMAC-SHA256 SignedHeaders=authorization;x-api-key;x-timestamp, Signature=. |
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
Request body
| Name | Type | Required | Description |
|---|---|---|---|
side | string | Required | Order Side. **Enum Value:**, `Buy`, `Sell` |
order_type | string | Required | Order Type. One of: `LO`, `ELO`, `MO`, `AO`, `ALO`, `ODD`, `LIT`, `MIT`, `TSLPAMT`, `TSLPPCT`, `SLO`. |
submitted_price | string | Optional | Submitted price, example: `1.5`. Required for limit order types such as `LO` |
submitted_quantity | string | Required | Submitted quantity (number of combinations), example: `1` |
strategy | string | Required | Multi-leg strategy. **Enum Value:**, `CoveredCall` - Covered stock, `CoveredPut` - Covered stock, `VerticalCallSpread` - Vertical spread, `VerticalPutSpread` - Vertical spread, `Collar` - Collar, `Straddle` - Straddle, `Strangle` - Strangle |
legs | array | Required | Legs of the combination order |
∟ symbol | string | Required | Option symbol, use `ticker.region` format, example: `QQQ260731C764000.US` |
∟ ratio_quantity | string | Required | Leg ratio quantity, example: `1` |
remark | string | Optional | Remark (Maximum 255 characters) |
client_request_id | string | Optional | Client request ID, used for idempotency (Maximum 64 characters) |
Response
Response JSON example
{
"code": 0,
"message": "success",
"data": {
"order_id": "683615454870679600"
}
}Error code
See the Error Codes page for the full list of error codes.