Skip to navigation

Amend algo order

Amend unfilled algo orders (Support Stop order and Trigger order only, not including Move_order_stop order, Iceberg order, TWAP order, Trailing Stop order).

Authentication

OK-ACCESS-KEYstring
Your API key.
OK-ACCESS-SIGNstring

Base64-encoded HMAC-SHA256 signature of the prehash string.

OK-ACCESS-TIMESTAMPstring

ISO 8601 UTC timestamp, e.g. 2020-12-08T09:08:57.715Z.

OK-ACCESS-PASSPHRASEstring
The passphrase you set when creating the API key.

Request

This endpoint expects an object.
instIdstringRequired
Instrument ID
algoIdstringOptional

Algo ID Either algoId or algoClOrdId is required. If both are passed, algoId will be used.

algoClOrdIdstringOptional

Client-supplied Algo ID Either algoId or algoClOrdId is required. If both are passed, algoId will be used.

cxlOnFailbooleanOptional

Whether the order needs to be automatically canceled when the order amendment fails Valid options: false or true, the default is false.

reqIdstringOptional

Client Request ID as assigned by the client for order amendment A combination of case-sensitive alphanumerics, all numbers, or all letters of up to 32 characters. The response will include the corresponding reqId to help you identify the request if you provide it in the request.

newSzstringOptional
New quantity after amendment and it has to be larger than 0.
newTpTriggerPxstringOptional

Take-profit trigger price. Either the take-profit trigger price or order price is 0, it means that the take-profit is deleted

newTpOrdPxstringOptional

Take-profit order price If the price is -1, take-profit will be executed at the market price.

newSlTriggerPxstringOptional

Stop-loss trigger price. Either the stop-loss trigger price or order price is 0, it means that the stop-loss is deleted

newSlOrdPxstringOptional

Stop-loss order price If the price is -1, stop-loss will be executed at the market price.

newTpTriggerPxTypeenumOptional

Take-profit trigger price type last: last price index: index price mark: mark price

Allowed values:
newSlTriggerPxTypeenumOptional

Stop-loss trigger price type last: last price index: index price mark: mark price

Allowed values:
newTriggerPxstringOptional
New trigger price after amendment
newOrdPxstringOptional

New order price after amendment If the price is -1, the order will be executed at the market price.

Response

Successful response
codestringOptional

Result code. 0 means success; any other value is an error code.

msgstringOptional
Error message. Empty on success.
datalist of objectsOptional