Skip to main content

CreateOrderRequest

symbolstringrequired

Market symbol

sizeint64required

Order size in contract units

sidestringrequired

Order side

Possible values: [BUY, SELL]

typestringrequired

Order type: LIMIT · MARKET · OCO (One-Cancels-the-Other)

Possible values: [LIMIT, MARKET, OCO]

pricenumber

Required for LIMIT orders

time_in_forcestring

Time in force: GTC (Good Till Cancelled) · IOC (Immediate Or Cancel) · FOK (Fill Or Kill) · HALFMIN (30 seconds) · FIVEMIN (5 minutes) · HOUR (1 hour) · TWELVEHOUR (12 hours) · DAY (1 day) · WEEK (1 week) · MONTH (1 month)

Possible values: [GTC, IOC, FOK, HALFMIN, FIVEMIN, HOUR, TWELVEHOUR, DAY, WEEK, MONTH]

txTypestring

Transaction type: LIMIT (default) · STOP (requires triggerPrice) · TRIGGER (requires triggerPrice)

Possible values: [LIMIT, STOP, TRIGGER]

stopPricenumber

Required for OCO orders

triggerPricenumber

Required for STOP, TRIGGER, and OCO orders

trailValuenumber

Trail value. TP/SL not supported when set

postOnlyboolean

Post-only order — charged maker fee

reduceOnlyboolean

Reduce-only order

clOrderIDstring

Custom order ID

triggerstring

Trigger type for STOP/TRIGGER: markPrice (default) or lastPrice

Possible values: [markPrice, lastPrice]

takeProfitPricenumber

Take profit trigger price

takeProfitTriggerstring

Take profit trigger type: markPrice (default) or lastPrice

Possible values: [markPrice, lastPrice]

stopLossPricenumber

Stop loss trigger price

stopLossTriggerstring

Stop loss trigger type: markPrice (default) or lastPrice

Possible values: [markPrice, lastPrice]

positionModestring

Position mode: ONE_WAY (default) · HEDGE · ISOLATED

Possible values: [ONE_WAY, HEDGE, ISOLATED]

CreateOrderRequest
{
"symbol": "string",
"size": 0,
"side": "BUY",
"type": "LIMIT",
"price": 0,
"time_in_force": "GTC",
"txType": "LIMIT",
"stopPrice": 0,
"triggerPrice": 0,
"trailValue": 0,
"postOnly": true,
"reduceOnly": true,
"clOrderID": "string",
"trigger": "markPrice",
"takeProfitPrice": 0,
"takeProfitTrigger": "markPrice",
"stopLossPrice": 0,
"stopLossTrigger": "markPrice",
"positionMode": "ONE_WAY"
}