Skip to main content

Create New Algo Order

Creates an algo (peg) order — price tracks market price within the specified deviation range.

Request Parameters

NameTypeRequiredDescription
symbolStringYesMarket symbol
priceDoubleYesMin price (sell) or max price (buy)
sizeLongYesOrder size
sideStringYesOrder side — BUY · SELL
clOrderIDStringNoCustom order ID
deviationDoubleNoDeviation from index price in % (-10 to 10)
stealthDoubleNoPercentage of order to display on orderbook
positionModeStringNoPosition mode: ONE_WAY (default) · HEDGE · ISOLATED

Response Content

NameTypeDescription
symbolStringMarket symbol
orderIDStringOrder ID
clOrderIDStringCustom order ID
orderTypeInteger76: Limit · 77: Market · 80: Algo
sideStringTrade side
priceDoubleOrder price
statusIntegerOrder status code: 2 (ORDER_INSERTED) · 4 (FULLY_MATCHED) · 5 (PARTIAL_FILL) · 6 (CANCELLED) · 9 (TRIGGER_INSERTED) · 10 (TRIGGER_ACTIVATED) · 15 (REJECTED)
time_in_forceStringTime in force: GTC · IOC · FOK · HALFMIN · FIVEMIN · HOUR · TWELVEHOUR · DAY · WEEK · MONTH
timestampLongOrder timestamp
triggerBooleanWhether order is a trigger order
triggerPriceDoubleTrigger price (0 if not a trigger order)
avgFilledPriceDoubleAverage filled price
messageStringTrade message
stealthDoubleAlgo orders only
deviationDoubleAlgo orders only
remainingSizeIntegerCurrent order size minus filled size
originalOrderSizeIntegerOriginal quantity — unchanged after amendments
currentOrderSizeIntegerLatest quantity (filled + remaining)
filledSizeIntegerQuantity filled in this update
totalFilledSizeIntegerCumulative filled quantity
postOnlyBooleanWhether order is post-only
positionModeStringONE_WAY · HEDGE · ISOLATED
positionDirectionStringPosition direction: LONG · SHORT (only present in HEDGE/ISOLATED mode)
positionIdStringPosition ID
example
POSThttps://api.btse.com/futures/api/v2.3/order/peg