PlaceOrderRequest

Note

For a more in depth documentation, you should check the comments from the protobuf file.

Purpose

Used for placing order on the current OE connection.

Mandatory fields

The mandatory fields for the place order request are order data information:

  • contract - name of instrument/contract

  • side - order on sell or buy, value has a Side type.

  • quantity - count of orders.

  • orderType - type or order (limit, market, stop, etc.), list of supported order type listed in OrderType enum.

  • lifeTime - type of order life time, value has a OrderLifeTime type.

  • price - the price at which the order will complete.

  • limitPrice - restriction on the maximum/minimum price

  • positionType - type of position (open/close), value has a PositionType type.

  • goodTillDate - date on which the order will expire (timestamp value)

  • sourceModule - the name of the module from which you want to place the order

  • ignoreValidation - determine, if need to check validity of order.

  • shouldWarnIfImmediatelyFilled - determine, if need to send warning, if the order will be immediately filled

  • fractionalQuantity - specify the fractional quantity (standart, mini, micro). Value has a FractionalQuantity type

  • overrideAccount - id of another account, from which need place order

Request example 

const PlaceOrderRequest {
  contract: "6BZ21",
  side: "BUY",
  quantity: 1,
  orderType: "LMT_ORDER_TYPE",
  lifeTime: "DAY_ORDER_LIFE_TIME",
  price: 0.5,
  goodTillDate: "1637798400000",
  ignoreValidation: true

}

Responses

The server will respond with a PlaceOrderResponse.