orders

Create Order

Creates an order, requires bearer token in authorization header.

This endpoint uses the signing format which does not require strict field ordering and addition of null fields in the request body. Quantities and prices does not require strict precision. E.g. for asset precision of 4 - 100, 100.0, 100.00, 100.000 and 100.0000 are all accepted.

Ratelimited: True. Higher tiers of rate limits available by providing the BX-RATELIMIT-TOKEN request header.

post/v2/orders

Request

Headers

BX-SIGNATUREstring required

signature obtained using the signing format

BX-TIMESTAMPstring required

timestamp is the number of milliseconds since EPOCH

BX-NONCEstring required

nonce is a client side incremented unsigned 64 bit integer

BX-NONCE-WINDOW-ENABLED'false' | 'true'

string representation of a boolean value, enables out-of-order order requests to be processed

BX-REFERRERstring

A numeric referrer id if applicable

Request body

commandTypestring required

The command type, it must be 'V3CreateOrder'

clientOrderIdstring

Unique numeric (i64) identifier generated on the client side expressed as a string value

symbolstring required

market symbol. E.g. BTCUSDC

typestring required

order type can have the following string values "LIMIT", "MARKET", "STOP_LIMIT", "POST_ONLY". "MARKET" and "STOP_LIMIT" are not applicable for Options

sidestring required

order side can have the following string values "BUY", "SELL"

pricestring

see asset value format

stopPricestring

see asset value format

quantitystring required

see asset value format

timeInForcestring required

time in force can have the following string values "GTC", "FOK", "IOC", "GTX" (Good Till Crossing - for auction orders), see details

allowBorrowboolean

allows to borrow on the order

isMMPboolean

Indicate if the order is subject to Market Maker Protection. Only applicable to option markets

tradingAccountIdstring required

unique trading account ID

Example request

{
  "clientOrderId": "299834741023572480",
  "symbol": "BTCUSDC",
  "type": "LIMIT",
  "side": "BUY",
  "price": "1.00000000",
  "stopPrice": "1.00000000",
  "quantity": "1.00000000",
  "timeInForce": "GTX",
  "isMMP": true,
  "tradingAccountId": "111000000000001"
}

Response

Status OK. The create order command was successfully acknowledged. To check the current status of the order, query Get Order by ID using the orderId received in the response payload. Please consult the section How To Ensure The Order Of Create Order or Cancel Order Requests for more information.

messagestring required

message

requestIdstring required
orderIdstring required
clientOrderIdstring

unique numeric identifier generated on the client side expressed as a string value

Example response

{
  "message": "Command acknowledged - CreateOrder",
  "requestId": "633910976353665024",
  "orderId": "633910775316480001",
  "clientOrderId": "1234567"
}

Changes

No recorded changes to this operation across all 1 revision of this API.