INinteractivebrokers
Orders

Modify Order

Allows the caller to modify the order with the referenced Customer Order ID specified in the URL. A separate Customer Order ID must be provided in the request body for the modification.

put/accounts/{account}/orders/{CustomerOrderId}

Request

  • Base URL
    https://www.interactivebrokers.com/tradingapi/v1
  • URL
    https://www.interactivebrokers.com/tradingapi/v1/accounts/{account}/orders/{CustomerOrderId}
  • Auth
    API key in header portal

Request body

OrigCustomerOrderIdstring

The order ID assigned by the customer

CustomerOrderIdstring

The new order ID assigned by the customer for the modification.

Quantitynumber

The number of units in the order; contracts or shares

Pricenumber

The order price

Order Type1 | 2 | 3 | 4

Market = '1' Limit = '2' Stop = '3' StopLimit = '4'

Aux Pricenumber

Required Price to support Stop and Stop Limit orders

Time in Force0 | 1 | 2 | 3 | 7

Defines order's active lifetime. Day = '0' GTC (Good till Cancel) = '1' IOC (Immediate or Cancel) = '3' Open = '2' Close = '7'

Outside RTHnumber

Indicates if order is active outside regular trading hours, where defined. 0 = no (default), 1 = yes

Side1 | 2

Buy = '1', Sell = '2'

GermanHftAlgoboolean

By setting this bool to false the customer attests that the order is not subject to German HFT Act, was not generated using any automated algorithm, and no algorithm determined or changed financial instrument, side, quantity, order type, limit or other price, trading venue or timing of this order. Currently we cannot accept orders where this flag is set to true. Such orders will be rejected.

Mifid2DecisionMakerstring

This field permits specification of the user's preregistered (via account management) MiFID II short code for decision makers.

Mifid2Algostring

This field permits specification of the user's preregistered (via account management) MiFID II short code for algos that are responsible for investment decisions

Mifid2ExecutionTraderstring

This field permits specification of the user's preregistered (via account management) MiFID II person responsible for handling/routing of the order

Mifid2ExecutionAlgostring

This field permits specification of the user's preregistered (via account management) MiFID II short code for algos that are responsible for handling/routing of the order.

Response

Result of order modification attempt

CustomerOrderIdstring
Symbolnumber
OrderQtynumber
Pricestring
Side1 | 2
Status'-1' | '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'A' | 'B' | 'C' | 'D' | 'E'

Status of the order InvalidOrderStatus = '-1' New = '0' PartiallyFilled = '1' Filled = '2' DoneForTheDay = '3' Canceled = '4' Replaced = '5' PendingCancelReplace = '6' Stopped = '7' Rejected = '8' Suspended = '9' PendingNew = 'A' Calculated = 'B' Expired = 'C' AcceptedForBidding = 'D' PendingReplace = 'E'

Warningstring
OrderType1 | 2 | 3 | 4

Market = '1' Limit = '2' Stop = '3' StopLimit = '4'

Changes

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