Receive a snapshot and updates for any order events on your account.
Subscribe to the account information channel to keep track of your orders. The account information channel provides a snapshot and updates on the orders in your account. The snapshot is delivered upon subscribing and any changes to your orders will be provided as updates for as long as the channel remains open. Any authenticated connection is automatically subscribed to the account information channel.
Example code to open an authenticated connection can be found on our Authenticated Channels Page.
Order events are sent with CHAN_ID = 0 and can be identified by looking at the TYPE stream field. Order events will use one of the following abbreviations: 'os' (order snapshot), 'on' (order new), 'ou' (order update), and 'oc' (order cancel).
[
CHAN_ID,
TYPE, //'os'
[
[
ID,
GID,
CID,
SYMBOL,
MTS_CREATE,
MTS_UPDATE,
AMOUNT,
AMOUNT_ORIG,
ORDER_TYPE,
TYPE_PREV,
MTS_TIF,
_PLACEHOLDER,
FLAGS,
STATUS,
_PLACEHOLDER,
_PLACEHOLDER,
PRICE,
PRICE_AVG,
PRICE_TRAILING,
PRICE_AUX_LIMIT,
_PLACEHOLDER,
_PLACEHOLDER,
_PLACEHOLDER,
NOTIFY,
HIDDEN,
PLACED_ID,
_PLACEHOLDER,
_PLACEHOLDER,
ROUTING,
_PLACEHOLDER,
_PLACEHOLDER,
META
],
...
]
]
[0,"os",[[34930659963,null,1574955083558,"tETHUSD",1574955083558,1574955083573,0.201104,0.201104,"EXCHANGE LIMIT",null,null,null,0,"ACTIVE",null,null,120,0,0,0,null,null,null,0,0,null,null,null,"BFX",null,null,{meta_object}]]]
[
CHAN_ID,
TYPE, // <'on', 'ou', 'oc'>
[
ID,
GID,
CID,
SYMBOL,
MTS_CREATE,
MTS_UPDATE,
AMOUNT,
AMOUNT_ORIG,
ORDER_TYPE,
TYPE_PREV,
MTS_TIF,
_PLACEHOLDER,
FLAGS,
ORDER_STATUS,
_PLACEHOLDER,
_PLACEHOLDER,
PRICE,
PRICE_AVG,
PRICE_TRAILING,
PRICE_AUX_LIMIT,
_PLACEHOLDER,
_PLACEHOLDER,
_PLACEHOLDER,
NOTIFY,
HIDDEN,
PLACED_ID,
_PLACEHOLDER,
_PLACEHOLDER,
ROUTING,
_PLACEHOLDER,
_PLACEHOLDER,
_PLACEHOLDER
]
]
[0,"oc",[34930659963,null,1574955083558,"tETHUSD",1574955083558,1574955354487,0.201104,0.201104,"EXCHANGE LIMIT",null,null,null,0,"CANCELED",null,null,120,0,0,0,null,null,null,0,0,null,null,null,"BFX",null,null,null]]
Stream Fields
Term | Type | Description |
---|---|---|
CHAN_ID | int | Identification number for the channel subscribtion. Order events are always sent through the account information channel with CHAN_ID = 0 |
TYPE | string | 'os' (order snapshot), 'on' (order new), 'ou' (order update), 'oc' (order cancel (canceled or fully executed)). |
ID | int | Order ID |
GID | int | Group ID |
CID | int | Client Order ID |
SYMBOL | string | Pair (tBTCUSD, …) |
MTS_CREATE | int | Millisecond timestamp of creation |
MTS_UPDATE | int | Millisecond timestamp of update |
AMOUNT | float | Positive means buy, negative means sell. |
AMOUNT_ORIG | float | Original amount |
ORDER_TYPE | string | The type of the order: LIMIT, MARKET, STOP, STOP LIMIT, TRAILING STOP, EXCHANGE MARKET, EXCHANGE LIMIT, EXCHANGE STOP, EXCHANGE STOP LIMIT, EXCHANGE TRAILING STOP, FOK, EXCHANGE FOK, IOC, EXCHANGE IOC. |
TYPE_PREV | string | Previous order type |
MTS_TIF | int | Millisecond timestamp of Time-In-Force: automatic order cancellation |
FLAGS | int | See https://docs.bitfinex.com/v2/docs/flag-values. |
ORDER_STATUS | string | Order Status: ACTIVE, EXECUTED @ PRICE(AMOUNT) e.g. "EXECUTED @ 107.6(-0.2)", PARTIALLY FILLED @ PRICE(AMOUNT), INSUFFICIENT MARGIN was: PARTIALLY FILLED @ PRICE(AMOUNT), CANCELED, CANCELED was: PARTIALLY FILLED @ PRICE(AMOUNT), RSN_DUST (amount is less than 0.00000001), RSN_PAUSE (trading is paused due to rebase events on AMPL or funding settlement on derivatives) |
PRICE | float | Price |
PRICE_AVG | float | Average price |
PRICE_TRAILING | float | The trailing price |
PRICE_AUX_LIMIT | float | Auxiliary Limit price (for STOP LIMIT) |
NOTIFY | int | 0 if false, 1 if true |
HIDDEN | int | 1 if Hidden, 0 if not hidden |
PLACED_ID | int | If another order caused this order to be placed (OCO) this will be that other order's ID |
ROUTING | string | indicates origin of action: BFX, ETHFX, API>BFX, API>ETHFX |
META | json string | Additional meta information about the order ( $F7 = IS_POST_ONLY (0 if false, 1 if true), $F33 = Leverage (int), aff_code: "aff_code_here") |
Multiple Flags
The summation of flags may result in multiple flags. For example 4160 (64 + 4096) means hidden post only.