Skip to main content

Create New Order

Creates a new order. Index Orders only support USD quotes.

Tip: Use clOrderID to track orders with your own identifier. This ID is returned in all order-related responses and WebSocket notifications.

Supports order types: LIMIT, MARKET, OCO, PEG (algo). For trigger orders, set txType to STOP or TRIGGER and provide triggerPrice.

Price by Order Type

Order TypeSideprice meaning
LIMITBUYMax price (quote currency) willing to pay per unit
LIMITSELLMin price (quote currency) willing to accept per unit
MARKETBUYMax total amount (quote currency) willing to spend
MARKETSELLNot applicable
TRIGGER LIMITBUYMax price willing to pay
TRIGGER LIMITSELLMin price willing to accept
TRIGGER MARKETBUYMax total amount willing to spend
TRAILING STOP MARKETBUYMax total amount willing to spend

Request Parameters

NameTypeRequiredDescription
symbolStringYesMarket symbol
priceDoubleNoRequired for LIMIT orders. For MARKET BUY, this is the max total amount (quote currency) willing to spend. Not applicable for MARKET SELL
sizeDoubleYesOrder size
sideStringYesOrder side — BUY · SELL
time_in_forceStringNoTime 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)
typeStringYesOrder type: LIMIT · MARKET · OCO (One-Cancels-the-Other) · PEG (algo order that tracks market price)
txTypeStringNoTransaction type: LIMIT (default) · STOP (requires triggerPrice) · TRIGGER (requires triggerPrice)
stopPriceDoubleNoMandatory for OCO orders
triggerPriceDoubleNoMandatory for Stop, Trigger, and OCO orders
trailValueDoubleNoTrail value. TP/SL not supported when set
postOnlyBooleanNoPost-only order — charged maker fees
clOrderIDStringNoCustom order ID
stealthDoubleNoPEG orders: percentage visible on orderbook
deviationDoubleNoPEG orders: deviation from index price (-10 to 10)
triggerPriceTypeStringNoTrigger price reference — INDEX_PRICE · LAST_PRICE

Response Content

NameTypeDescription
symbolStringMarket symbol
orderIDStringInternal order ID
clOrderIDStringCustom order ID
sideStringBUY or SELL
priceDoubleOrder price
orderTypeInteger76: Limit · 77: Market · 80: Peg/Algo
statusIntegerOrder status code: 2 (ORDER_INSERTED) · 4 (FULLY_MATCHED) · 5 (PARTIAL_FILL) · 6 (CANCELLED) · 9 (TRIGGER_INSERTED) · 10 (TRIGGER_ACTIVATED) · 15 (REJECTED)
averageFillPriceDoubleAverage fill price
originalOrderBaseSizeDoubleOriginal order quantity expressed in base currency
originalOrderQuoteSizeDoubleOriginal order quantity expressed in quote currency
currentOrderBaseSizeDoubleLatest order quantity in base currency (after amendments / partial fills)
currentOrderQuoteSizeDoubleLatest order quantity in quote currency
remainingOrderBaseSizeDoubleUnfilled quantity in base currency
remainingOrderQuoteSizeDoubleUnfilled quantity in quote currency
filledBaseSizeDoubleMost recent fill quantity in base currency
totalFilledBaseSizeDoubleCumulative filled quantity in base currency
orderCurrencyStringCurrency the order size is denominated in: base or quote
sizeDoubleDeprecated in v3.3. Use originalOrderBaseSize / originalOrderQuoteSize
fillSizeDoubleDeprecated in v3.3. Use filledBaseSize / totalFilledBaseSize
remainingSizeDoubleDeprecated in v3.3. Use remainingOrderBaseSize / remainingOrderQuoteSize
originalSizeDoubleDeprecated in v3.3. Use originalOrderBaseSize / originalOrderQuoteSize
triggerPriceDoubleTrigger price (0 if not a trigger order)
stopPriceDoubleStop price
time_in_forceStringTime in force: GTC · IOC · FOK · HALFMIN · FIVEMIN · HOUR · TWELVEHOUR · DAY · WEEK · MONTH
timestampLongOrder timestamp
triggerBooleanWhether the order is a trigger order
postOnlyBooleanWhether post-only
stealthDoubleStealth value
deviationDoubleDeviation value
example
POSThttps://api.btse.com/spot/api/v3.3/order

Request (MARKET order)

{
"symbol": "BTC-USD",
"size": 1,
"side": "BUY",
"type": "MARKET"
}

Request (LIMIT order)

{
"symbol": "BTC-USD",
"size": 1,
"price": 34000,
"side": "BUY",
"type": "LIMIT"
}

Request (OCO order)

{
"symbol": "BTC-USD",
"size": 1,
"price": 24000,
"side": "BUY",
"type": "OCO",
"txType": "LIMIT",
"stopPrice": 40010,
"triggerPrice": 40000
}

Response

[
{
"status": 2,
"symbol": "BTC-USD",
"orderType": 76,
"price": 34000,
"side": "BUY",
"orderID": "990db9b6-2ed4-4c68-b46e-827c88cc3884",
"timestamp": 1660208800123,
"triggerPrice": 0,
"stopPrice": null,
"trigger": false,
"averageFillPrice": 0,
"clOrderID": null,
"postOnly": false,
"time_in_force": "GTC",
"orderCurrency": "base",
"originalOrderBaseSize": 1,
"originalOrderQuoteSize": 34000,
"currentOrderBaseSize": 1,
"currentOrderQuoteSize": 34000,
"remainingOrderBaseSize": 1,
"remainingOrderQuoteSize": 34000,
"filledBaseSize": 0,
"totalFilledBaseSize": 0
}
]