CQG API 4.0 - Revised
CQGOrder Interface Members
See Also  Overview  Send Feedback

Glossary Item Box

Public Methods

Public Method Activate

Activates the current order if it is parked.

Public Method Cancel

Requests the current order cancellation.

Public Method Modify

Requests the current order modification.

Public Method ParkParks the current order if it is active.
Public Method Place

Puts current order in the placement queue.

Public Method PrepareModify

Creates an order modification object which can be filled with desired changes and passed to Modify method.

Public Method SendCareOrderAckSends the special care order acknowledgment. Requires APICareOrders enablement

Public Properties

Public Property Account

Gets/sets the corresponding CQGAccount object of the order.

Public Property AlgorithmIDGets algorithm id of the order
Public Property AlgorithmStringIDGets algorithm id of the order represented as string
Public Property CanBeCanceled

Returns the order availability for cancellation.

Public Property CanBeModified

Returns the order availability for modification.

Public Property CanBeParked

Returns the order availability for parking.

Public Property CanBeReplaced

Indicates whether the order can be replaced with a market order or not.

Public Property CancelationInstruction

Gets/sets order cancelation instruction type for strategy orders.

Public Property Description

Gets/sets custom description of the order.

Public Property DurationType

Gets/sets the type of order duration.

Public Property FilledQuantity

Returns the order filled quantity.

Public Property FilledQuantityFractionalOrder filled fractional quantity
Public Property Fills

Returns the collection of order fills.

Public Property ForceClientExecutionDecisionExecution within the firm
Public Property GUID

Returns Order GUID.

Public Property GWOrderID

Returns order Gateway identifier.

Public Property GWStatus

Returns order Gateway status.

Public Property Instrument

Gets/sets the instrument of the order.

Public Property InstrumentName

Returns the full name of the instrument on which the order is created.

Public Property IsExternal

Identifies if current order is external for this instance of CQG API.

Public Property IsFinal

Identifies if current order status is final.

Public Property LastError

Returns the last error that occurred in this order.

Public Property LastEvent

Returns the last event of the order.

Public Property LimitPrice

Gets/sets the order Limit Price.

Public Property ManualWhether an order is placed manually or not
Public Property MiFIDAlgorithmIDMiFID algorithm ID
Public Property OrderCheckMarkGets the order check mark value
Public Property OriginalOrderID

Returns the original order Gateway identifier.

Public Property PlaceTime

Returns the order placing time (local time, converted to the user-configured time zone).

Public Property Properties

Returns a collection of all possible and acceptable (decided depending on the order type) order properties.

This is the default property.

Public Property Quantity

Gets/sets the quantity of the order.

Public Property QuantityFractionalOrder fractional quantity
Public Property RemainingQuantity

Returns the remaining quantity of the order, i.e. the part of order quantity which is still not filled.

Public Property RemainingQuantityFractionalOrder remaining fractional quantity
Public Property Reserved45Reserved method
Public Property ServerTimestamp

Timestamp of the last change (server time, converted to the configured time zone).
Each order change event forces this property to change its value.

Public Property Side

Gets/sets the side of the order.

Public Property State

Returns the order's local state.

Public Property StopPrice

Gets/sets order Stop Price.

Public Property Tag

This property allows the user to keep his/her own information within the Order object. Multiple pieces of information can be kept in the Tag property under different keys.

Public Property TimeActiveAt

Returns the order activation time (converted to configured time zone).

Public Property Timestamp

Returns the last response reception timestamp.

When a property is updated, CQG API records the information reception time in the Timestamp property (using local time).

Each order change event forces this property to change its value.

Public Property Transactions

Returns all transactions of the order.

Public Property Type

Returns the type of the order.

Public Property UEName

Returns the order UEName.

See Also