BUbullish
orders

Amend Order Command

Ability to amend the price, quantity and type (i.e. change from Taker Only to Maker Only and vice versa) on GTC Limit orders. It can be applied only to open orders (quantityFilled=0 and status=OPEN). For Auction Limit Orders (LOC), only price can be amended. Auction Market Orders (MOC) do not support amendment.

Submits a command to the trading engine to amend an order. A successful response indicates that the command entry was acknowledged but does not indicate that the command was executed.

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.

Requires

  • bearer token in authorization header

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

post/v2/command#amend

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

Request body

commandType'V1AmendOrder' required

The command type, it must be 'V1AmendOrder'

orderIdstring
symbolstring required

market symbol. E.g. BTCUSDC

typestring

order type can have the following string values "LIMIT", "POST_ONLY"

pricestring

see asset value format

clientOrderIdstring

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

quantitystring

see asset value format

tradingAccountIdstring required

unique trading account ID

Example request

{
  "commandType": "V1AmendOrder",
  "orderId": "297735387747975680",
  "symbol": "BTCUSDC",
  "type": "LIMIT",
  "price": "1.00000000",
  "clientOrderId": "633914459442118656",
  "quantity": "1.00000000",
  "tradingAccountId": "111000000000001"
}

Response

Status OK. This means a command was successfully acknowledged.

commandType'V1AmendOrder' required

The command type

messagestring required

message

requestIdstring required
orderIdstring required
clientOrderIdstring

Will be updated as part of a successful order amendment

Example response

{
  "commandType": "V1AmendOrder",
  "message": "Command acknowledged - AmendOrder",
  "requestId": "633910976353665024",
  "orderId": "633910775316480001",
  "clientOrderId": "1234567-1"
}

Changes

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