v1

latestSwagger 2.02026-07-179553242.0 KB

Order

Amend the quantity or price of an open order.

Send an orderID or origClOrdID to identify the order you wish to amend.

Both order quantity and price can be amended. Only one qty field can be used to amend.

Use the leavesQty field to specify how much of the order you wish to remain open. This can be useful if you want to adjust your position's delta by a certain amount, regardless of how much of the order has already filled.

A leavesQty can be used to make a "Filled" order live again, if it is received within 60 seconds of the fill.

put/order

Response

Request was successful

orderIDstring guid required

clOrdIDstring

clOrdLinkIDstring

accountinteger

symbolstring

sidestring

orderQtyinteger

pricenumber double

displayQtyinteger

stopPxnumber double

pegOffsetValuenumber double

pegPriceTypestring

currencystring

settlCurrencystring

ordTypestring

timeInForcestring

execInststring

contingencyTypestring

ordStatusstring

triggeredstring

workingIndicatorboolean

ordRejReasonstring

leavesQtyinteger

cumQtyinteger

avgPxnumber double

textstring

transactTimestring date-time

timestampstring date-time

Example response

{
  "symbol": "symbol",
  "triggered": "triggered",
  "clOrdLinkID": "clOrdLinkID",
  "execInst": "execInst",
  "pegOffsetValue": 2.3021358869347655,
  "pegPriceType": "pegPriceType",
  "contingencyType": "contingencyType",
  "settlCurrency": "settlCurrency",
  "ordRejReason": "ordRejReason",
  "price": 1.4658129805029452,
  "orderQty": 6,
  "currency": "currency",
  "text": "text",
  "timeInForce": "timeInForce",
  "timestamp": "2000-01-23T04:56:07.000+00:00",
  "ordStatus": "ordStatus",
  "side": "side",
  "orderID": "orderID",
  "leavesQty": 7,
  "cumQty": 9,
  "displayQty": 5,
  "clOrdID": "clOrdID",
  "avgPx": 3.616076749251911,
  "workingIndicator": true,
  "transactTime": "2000-01-23T04:56:07.000+00:00",
  "account": 0,
  "stopPx": 5.637376656633329,
  "ordType": "ordType"
}