v1

latestOpenAPI 3.1.02026-07-24690345.5 KB

Update Order

Updates an existing order, can be used to update margin, exchange, and derivative orders.

post/auth/w/order/update

Request body

idinteger required

The ID of the order to update (can be retrieved by calling the Retrieve Orders and the Retrieve Orders (by symbol) endpoints).

amountstring

Amount of order (positive for buy, negative for sell).

pricestring

Price of the order.

cidinteger

Client Order ID; should be unique in the day (UTC+0).

cid_datestring

YYYY-MM-DD Date of Client Order ID.

gidinteger

Group ID for the order.

flagsinteger

The sum of all order flags (see https://docs.bitfinex.com/docs/flag-values).

levinteger

Set the leverage for a derivative order, supported by derivative symbol orders only. The value should be between 1 and 100 inclusive. -- Mandatory for derivative order updates

deltastring

The delta to apply to the amount value.

price_aux_limitstring

Auxiliary Limit price (only for STOP LIMIT).

price_trailingstring

The trailing price for a trailing stop order.

tifstring

Time-In-Force: UTC datetime for automatic order cancellation (e.g. 2020-01-15 10:45:23). Note: TIF can be updated but not removed.

Response

200

{"stackTrail":"paths:/auth/w/order/update:post:responses:200:content:application/json:schema:items","oasType":"schema","type":"unknown"}