To submit an order, construct a payload using the "on" (order new) abbreviation and include the desired order details. Please look to the sidebar for a model and an example.

Upon submitting the order, you will receive a message of the appropriated type on the "account info" channel. Example responses are included in the sidebar. Please look to the Orders and Notifications pages for further information, such as the response fields.

Order inputs require you to run the authentication code along with additional code for the input. The authentication code can be found on our Authenticated Channels and the additional code for inputs can be found on the Websocket Inputs page.

// Model
[
  0,
  "on",
  null,
  {
    "gid": GID,
    "cid": CID,
    "type": TYPE,
    "symbol": SYMBOL,
    "amount": AMOUNT,
    "price": PRICE,
    "meta": {aff_code: "AFF_CODE_HERE"} // optional param to pass an affiliate code
    ...
  }
]

// Example
[
  0,
  "on",
  null,
  {
    "gid": 1,
    "cid": 12345,
    "type": "LIMIT",
    "symbol": "tBTCUSD",
    "amount": "1.0",
    "price": "500"
  }
]

// When the order is submitted you will receive an 'n' (notification) event as confirmation. If the order request is successful, you will also receive  an 'on' (order new) event. Both events are sent through CHANNEL_ID = 0.

[
  0, // CHANNEL_ID
  "n", // EVENT
  [
    1575287438515, // MTS 
    "on-req", // TYPE 
    null, // MESSAGE_ID 
    null, // _PLACEHOLDER 
    [
      1185815098, // ID
      null, // GID
      1575287436979, // CID
      "tETHUSD", // SYMBOL
      1575287438515, // MTS_CREATE
      1575287438515, // MTS_UPDATE
      -2.5, // AMOUNT
      -2.5, // AMOUNT_ORIG
      "LIMIT", // ORDER_TYPE
      null, // TYPE_PREV
      null, // MTS_TIF
      null, // _PLACEHOLDER
      0, // FLAGS
      "ACTIVE", // STATUS
      null, // _PLACEHOLDER
      null, // _PLACEHOLDER
      230, // PRICE
      0, // PRICE_AVG
      0, // PRICE_TRAILING
      0, // PRICE_AUX_LIMIT
      null, // _PLACEHOLDER
      null, // _PLACEHOLDER
      null, // _PLACEHOLDER
      0, // NOTIFY
      null, // HIDDEN
      null, // PLACED_ID
      null, // _PLACEHOLDER
      null, // _PLACEHOLDER
      "API>BFX", // ROUTING
      null, // _PLACEHOLDER
      null, // _PLACEHOLDER
      null // META
    ],
    null, // CODE 
    "SUCCESS", // STATUS 
    "Submitting limit sell order for -2.5 ETH." // TEXT 
  ]
]

[
  0, // CHANNEL_ID
  "on", // EVENT
  [
    1185815098, // ID
    null, // GID
    1575287436979, // CID
    "tETHUSD", // SYMBOL
    1575287438515, // MTS_CREATE
    1575287438519, // MTS_UPDATE
    -2.5, // AMOUNT
    -2.5, // AMOUNT_ORIG
    "LIMIT", // ORDER_TYPE
    null, // TYPE_PREV
    null, // MTS_TIF
    null, // _PLACEHOLDER
    0, // FLAGS
    "ACTIVE", // STATUS
    null, // _PLACEHOLDER
    null, // _PLACEHOLDER
    230, // PRICE
    0, // PRICE_AVG
    0, // PRICE_TRAILING
    0, // PRICE_AUX_LIMIT
    null, // _PLACEHOLDER
    null, // _PLACEHOLDER
    null, // _PLACEHOLDER
    0, // NOTIFY
    0, // HIDDEN
    null, // PLACED_ID
    null, // _PLACEHOLDER
    null, // _PLACEHOLDER
    "API>BFX", // ROUTING
    null, // _PLACEHOLDER
    null, // _PLACEHOLDER
    null // META
  ]
]

Request fields

Name	Type	Description
gid	Int	(optional) Group id for the order
cid	Int	Should be unique in the day (UTC) (not enforced)
type	String	The type of the order: 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.
symbol	String	symbol (tBTCUSD, tETHUSD, ...)
amount	Decimal string	Positive for buy, Negative for sell
price	Decimal string	Price (Not required for market orders)
lev	Int	Set the leverage for a derivative order, supported by derivative symbol orders only. The value should be between 1 and 100 inclusive. The field is optional, if omitted the default leverage value of 10 will be used.
price_trailing	Decimal string	The trailing price
price_aux_limit	Decimal string	Auxiliary Limit price (for STOP LIMIT)
price_oco_stop	Decimal string	OCO stop price
flags	Int	See `<https://docs.bitfinex.com/v2/docs/flag-values>`.
tif	Datetime 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}`

📘
meta: {aff_code: ...}
API orders can now pass an affiliate code through which you can earn rebates. To learn more about these rebates and our affiliate program, please look at the relevant announcement and knowledge base article.

🚧
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.

Order types

Additional information about the types of orders can be found here:
<https://support.bitfinex.com/hc/en-us/articles/115003506105-Limit-Order>

📘
Multiple Flags
You may sum flag values to pass multiple flags. For example, passing 4160 (64 + 4096) means hidden and post only.
The default value is 0 and indicates that no flags will be used.

New order notification data

Index	Field	Type	Description
[0]	CHANNEL_ID	Int	ID of the channel. (0 for account info messages)
[1]	EVENT	String	Type of event ('n' for notification)
[2]	NOTIFICATION_ARRAY	Array	Notification array

Notification array data

Index	Field	Type	Description
[0]	MTS	Int	Millisecond Time Stamp of the update
[1]	TYPE	String	Purpose of notification ('on-req', 'oc-req', 'uca', 'fon-req', 'foc-req')
[2]	MESSAGE_ID	Int	Unique ID of the message
[3]	PLACEHOLDER
[4]	ORDER_ARRAY	Array	Order data
[5]	CODE	Null or Integer	Work in progress
[6]	STATUS	String	Status of the notification; it may vary over time (SUCCESS, ERROR, FAILURE, ...)
[7]	TEXT	String	Text of the notification

"on" event data

Index	Field	Type	Description
[0]	CHANNEL_ID	Int	ID of the channel. (0 for account info messages)
[1]	TYPE	String	Purpose of notification ('on-req', 'oc-req', 'uca', 'fon-req', 'foc-req')
[2]	ORDER_ARRAY	Array	Order data

Order Array data

Index	Field	Type	Description
[0]	ID	Int	Order ID
[1]	GID	Int	Group ID
[2]	CID	Int	Client Order ID
[3]	SYMBOL	String	Pair (tBTCUSD, …)
[4]	MTS_CREATE	Int	Millisecond timestamp of creation
[5]	MTS_UPDATE	Int	Millisecond timestamp of update
[6]	AMOUNT	Float	Positive means buy, negative means sell.
[7]	AMOUNT_ORIG	Float	Original amount
[8]	ORDER_TYPE	String	The type of the order: LIMIT, MARKET, STOP, STOP LIMIT, TRAILING STOP, FOK, IOC For exchange orders: EXCHANGE MARKET, EXCHANGE LIMIT, EXCHANGE STOP, EXCHANGE STOP LIMIT, EXCHANGE TRAILING STOP, EXCHANGE FOK, EXCHANGE IOC.
[9]	TYPE_PREV	String	Previous order type
[10]	MTS_TIF	Int	Millisecond timestamp of Time-In-Force: automatic order cancellation
[ . . . ]
[12]	FLAGS	Int	See https://docs.bitfinex.com/v2/docs/flag-values
[13]	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)
[ . . . ]
[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	0 if false, 1 if true
[24]	HIDDEN	Int	1 if Hidden, 0 if not 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
[ . . . ]
[31]	META	Json string	Additional meta information about the order (e.g., $F7 = IS_POST_ONLY (0 if false, 1 if true), $F33 = Leverage (int), aff_code: "aff_code_here")