Update Order

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

Response Fields

This endpoint returns a notification.

Index Field Type Description
[0] MTS int Milliseconds epoch timestamp of notification
[1] TYPE string Notification's type ("ou-req")
[2] MESSAGE_ID int Unique notification's ID
[ . . . ]
[4] DATA Order The order that has been updated
[5] CODE int W.I.P. (work in progress)
[6] STATUS string Status of the notification; it may vary over time (SUCCESS, ERROR, FAILURE, ...)
[7] TEXT string Additional notification description

Order objects

Index Field Type Description
[0] ID int Order ID
[1] GID int Group Order ID
[2] CID int Client Order ID
[3] SYMBOL string Trading pair (tBTCUSD, tLTCETH, ...)
[4] MTS_CREATE int Millisecond epoch timestamp of creation
[5] MTS_UPDATE int Millisecond epoch timestamp of last update
[6] AMOUNT float Positive means buy, negative means sell
[7] AMOUNT_ORIG float Original amount (before any update)
[8] ORDER_TYPE string The order's type (see list below)
[9] TYPE_PREV string Previous order type (before the last update)
[10] MTS_TIF int Millisecond epoch timestamp for TIF (Time-In-Force)
[ . . . ]
[12] FLAGS int Sum of all active flags for the order (values can be found here)
[13] STATUS string A complete overview on available order statuses can be found here
[ . . . ]
[16] PRICE float Price
[17] PRICE_AVG float Average price
[18] PRICE_TRAILING float The trailing price
[19] PRICE_AUX_LIMIT float Auxiliary Limit price (for STOP LIMIT)
[ . . . ]
[23] NOTIFY int 1 if operations on order must trigger a notification, 0 if operations on order must not trigger a notification
[24] HIDDEN int 1 if order must be hidden, 0 if order must not be hidden
[25] PLACED_ID int If another order caused this order to be placed (OCO) this will be that other order's ID
[ . . . ]
[28] ROUTING string Indicates origin of action: BFX, API>BFX
[ . . . ]
[31] META JSON Additional meta information about the order ( $F7 = IS_POST_ONLY (0 if false, 1 if true), $F33 = Leverage (int), aff_code: "aff_code_here")

📘

Available order types

Available order types are: LIMIT, EXCHANGE LIMIT, MARKET, EXCHANGE MARKET, STOP, EXCHANGE STOP, STOP LIMIT, EXCHANGE STOP LIMIT, TRAILING STOP, EXCHANGE TRAILING STOP, FOK, EXCHANGE FOK, IOC, EXCHANGE IOC.

📘

Using multiple flags at once

You may sum flag values to pass multiple flags.
For example, 4160 (64 + 4096) means Hidden and Post Only.

🚧

meta: {protect_selfmatch: 1}

The 'protect_selfmatch' flag can be used to avoid matching orders with standing orders on the same account. This flag is passed in the meta object in the order body when submitting or updating your orders.

Note that this flag is only intended to assist users in avoiding unintentional wash trading. As per our trading rulebook, wash trading is forbidden on the platform.


Rate Limit: 90 reqs/min (requests per minute)

Body Params
int64
required

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

string

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

string

Price of the order.

int64

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

string

YYYY-MM-DD Date of Client Order ID.

int64

Group ID for the order.

int32

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

int32

Set the leverage for a derivative order, supported by derivative symbol orders only. The value should be between 1 and 100 inclusive. If omitted the default leverage value of 10 will be used.

string

The delta to apply to the amount value.

string

Auxiliary Limit price (only for STOP LIMIT).

string

The trailing price for a trailing stop order.

string

Time-In-Force: datetime for automatic order cancellation (e.g. 2020-01-15 10:45:23).

meta
object

Object to pass order meta data. Options: 'aff_code' (to pass affiliate codes), 'make_visible' (to toggle visible on hit for hidden orders), 'protect_selfmatch' (to cancel submitted order if it would match with one of your own orders). Example: meta: {aff_code: "AFF_CODE_HERE", make_visible: 1}

Response

Language
Choose an example:
application/json