Skip to main content

CreateOrderRequest

symbolstringrequired

Market symbol

pricenumber

Required for LIMIT orders. For MARKET BUY, this is the max total amount (quote currency) willing to spend. Not applicable for MARKET SELL

sizenumberrequired

Order size

sidestringrequired

Order side

Possible values: [BUY, SELL]

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]

typestringrequired

Order type: LIMIT · MARKET · OCO (One-Cancels-the-Other) · PEG (algo order that tracks market price)

Possible values: [LIMIT, MARKET, OCO, PEG]

txTypestring

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

Possible values: [LIMIT, STOP, TRIGGER]

stopPricenumber

Mandatory for OCO orders

triggerPricenumber

Mandatory for Stop, Trigger, and OCO orders

trailValuenumber

Trail value. TP/SL not supported when set

postOnlyboolean

Post-only order — charged maker fees

clOrderIDstring

Custom order ID

stealthnumber

PEG orders: percentage visible on orderbook

deviationnumber

PEG orders: deviation from index price (-10 to 10)

triggerPriceTypestring

Trigger price reference

Possible values: [INDEX_PRICE, LAST_PRICE]

CreateOrderRequest
{
"symbol": "string",
"price": 0,
"size": 0,
"side": "BUY",
"time_in_force": "GTC",
"type": "LIMIT",
"txType": "LIMIT",
"stopPrice": 0,
"triggerPrice": 0,
"trailValue": 0,
"postOnly": true,
"clOrderID": "string",
"stealth": 0,
"deviation": 0,
"triggerPriceType": "INDEX_PRICE"
}