Skip to main content

AmendOrderReq

orderIdstring

Server-assigned order id of the order to amend. Required if clOrderId is not provided.

clOrderIdstring

Client-assigned order id of the order to amend. Required if orderId is not provided.

symbolstringrequired

Trading pair symbol of the order to amend.

amendTypestringrequired

Which field to amend: PRICE, SIZE, TRIGGER_PRICE, or ALL.

Possible values: [PRICE, SIZE, TRIGGER_PRICE, ALL]

orderSizedouble

New order size in number of contracts. Required when amendType is SIZE, or ALL when combined with orderPrice.

orderPricedouble

New limit price. Required when amendType is PRICE (unless slide is true) or ALL when combined with orderSize.

triggerPricedouble

New trigger price. Required when amendType is TRIGGER_PRICE.

slideboolean

If true and amendType is PRICE, the price is slid to the best available price instead of being taken from orderPrice.

totalAmountModeboolean

If true, orderSize is treated as the desired total original size rather than an incremental change.

AmendOrderReq
{
"orderId": "string",
"clOrderId": "string",
"symbol": "string",
"amendType": "PRICE",
"orderSize": 0,
"orderPrice": 0,
"triggerPrice": 0,
"slide": true,
"totalAmountMode": true
}