Skip to main content

Peg

Peg order whose working price automatically tracks the best bid or ask, offset by an optional deviation.

orderType stringrequired

Peg order whose working price automatically tracks the best bid or ask, offset by an optional deviation.

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

Order size in number of contracts.

positionModestring

Position mode this order applies to (one-way or hedge).

Possible values: [ONE_WAY, HEDGE, ISOLATED]

orderPricedouble

Optional worst-price limit; the pegged price will not cross this bound.

deviationdoublerequired

Offset applied to the pegged reference price.

stealthdoublerequired

Portion of the order size displayed on the book; the remainder is hidden.

Peg
{
"orderType": "LIMIT",
"clOrderId": "string",
"symbol": "string",
"orderSide": "BUY",
"orderSize": 0,
"positionMode": "ONE_WAY",
"orderPrice": 0,
"deviation": 0,
"stealth": 0
}