Skip to main content

private/advanced/amend-order

POST 
/private/advanced/amend-order
Amends an existing trigger order on the Exchange.

This call is asynchronous, so the response is simply a confirmation of the request.

The user.advanced.order subscription can be used to check when the order is successfully amended.

Trigger Order Type Conversion:

  • Set new_price to "0" → Convert trigger limit order to trigger market order
  • Set new_price to "> 0" → Convert trigger market order to trigger limit order

Request​

Body

required
    id int64required

    Request id (echoed in response)

    method stringrequired

    Must be "private/advanced/amend-order"

    api_key stringrequired

    Your API key (only required for private REST)

    sig stringrequired

    HMAC-SHA256 signature in hex (only required for private REST)

    nonce int64required

    Current timestamp in milliseconds, e.g. "1771761038000".

    params objectrequired
    order_id int64

    Order ID to amend. Either order_id or client_oid must be present. string format is highly recommended.

    client_oid string

    Client Order ID to amend. Either order_id or client_oid must be present.

    new_ref_price decimal

    New reference/trigger price. Omit to keep the existing trigger price.

    new_quantity decimalrequired

    New quantity. If no change required, input original value.

    new_price decimalrequired

    New limit price for the trigger order. Set to '0' to convert trigger limit to market, or value > 0 to convert market to limit.

Success.
Schema
    id int64

    Echoed request id

    method string

    Method invoked

    code int32

    0 = success; non-zero indicates error (reason code).

    result object
    Present when code === 0. Contains order_id and client_oid.
    order_id int64

    Order ID.

    client_oid string

    Client Order ID.

    message string

    Present when code !== 0.

    original string

    Present when code !== 0.