Skip to main content

Twap

TWAP (Time-Weighted Average Price) order that splits the parent size into smaller child orders spread over a fixed time window.

orderType stringrequired

TWAP (Time-Weighted Average Price) order that splits the parent size into smaller child orders spread over a fixed time window.

Possible values: []

clOrderIdstring

Client-assigned order identifier for tracking and idempotency.

symbolstringrequired

Trading pair symbol.

orderSidestringrequired

Order side: BUY or SELL.

Possible values: [BUY, SELL]

orderSizeint64required

Total order size in number of contracts, distributed across child orders.

reduceOnlyboolean

If true, the order can only reduce an existing position and cannot open or increase one.

timePeriodint64

Total execution window in seconds over which child orders are dispatched.

Possible values: >= 60 and <= 86400

randomizeSizeboolean

If true, individual child order sizes are randomized within limits to reduce predictability.

subTwapMaxOrderSizedouble

Maximum size of each child order.

maxSpreaddouble

Maximum acceptable bid-ask spread. Child orders are paused when the spread is wider.

makerFirstboolean

If true, child orders prefer maker execution before falling back to taker behavior.

maxDistanceThroughBookdouble

Maximum distance a child order may cross into the order book.

pausePricedouble

Reference price beyond which the TWAP schedule pauses to avoid adverse execution.

activationTriggerPricedouble

Optional price at which the TWAP schedule begins. Inactive until this price is reached.

activationTriggerTypestring

Reference price type used to evaluate the activation price.

Possible values: [INDEX_PRICE, LAST_PRICE, MARK_PRICE]

Twap
{
"orderType": "LIMIT",
"clOrderId": "string",
"symbol": "string",
"orderSide": "BUY",
"orderSize": 0,
"reduceOnly": true,
"timePeriod": 0,
"randomizeSize": true,
"subTwapMaxOrderSize": 0,
"maxSpread": 0,
"makerFirst": true,
"maxDistanceThroughBook": 0,
"pausePrice": 0,
"activationTriggerPrice": 0,
"activationTriggerType": "INDEX_PRICE"
}