Table of Contents

Class InteractiveBrokersOrderCondition

Namespace
StockSharp.InteractiveBrokers
Assembly
StockSharp.InteractiveBrokers.dll

StockSharp.InteractiveBrokers order condition.

[Display(ResourceType = typeof(LocalizedStrings), Name = "InteractiveBrokers")]
public class InteractiveBrokersOrderCondition : OrderCondition, ICloneable<OrderCondition>, ICloneable, IStopLossOrderCondition
Inheritance
InteractiveBrokersOrderCondition
Implements
Inherited Members
Extension Methods

Constructors

InteractiveBrokersOrderCondition()

Initializes a new instance of the InteractiveBrokersOrderCondition.

public InteractiveBrokersOrderCondition()

Properties

Active

Condition for GTC orders.

[TypeConverter(typeof(ExpandableObjectConverter))]
public InteractiveBrokersOrderCondition.ActiveCondition Active { get; }

Property Value

InteractiveBrokersOrderCondition.ActiveCondition

AdjustableTrailingUnit

Adjusted Stop orders: specifies where the trailing unit is an amount (set to 0) or a percentage (set to 1).

public int? AdjustableTrailingUnit { get; set; }

Property Value

int?

AdjustedOrderType

Adjusted Stop orders: the parent order will be adjusted to the given type when the adjusted trigger price is penetrated.

public string AdjustedOrderType { get; set; }

Property Value

string

AdjustedStopLimitPrice

Adjusted Stop orders: specifies the stop limit price of the adjusted (STPL LMT) parent.

public decimal? AdjustedStopLimitPrice { get; set; }

Property Value

decimal?

AdjustedStopPrice

Adjusted Stop orders: specifies the stop price of the adjusted (STP) parent.

public decimal? AdjustedStopPrice { get; set; }

Property Value

decimal?

AdjustedTrailingAmount

Adjusted Stop orders: specifies the trailing amount of the adjusted (TRAIL) parent.

public decimal? AdjustedTrailingAmount { get; set; }

Property Value

decimal?

AdvancedErrorOverride

Accepts a list with parameters obtained from advancedOrderRejectJson.

public string AdvancedErrorOverride { get; set; }

Property Value

string

Agent

Trader ID.

public InteractiveBrokersOrderCondition.AgentDescriptions? Agent { get; set; }

Property Value

InteractiveBrokersOrderCondition.AgentDescriptions?

Algo

Condition for algo-orders.

[TypeConverter(typeof(ExpandableObjectConverter))]
public InteractiveBrokersOrderCondition.AlgoCondition Algo { get; }

Property Value

InteractiveBrokersOrderCondition.AlgoCondition

AlgoId

Algorithm ID.

[Display(ResourceType = typeof(LocalizedStrings), Name = "Algo", Description = "Algo", GroupName = "Parameter")]
public string AlgoId { get; set; }

Property Value

string

AllOrNone

Wait for required volume to appear.

public bool? AllOrNone { get; set; }

Property Value

bool?

AuctionStrategy

Trading.

public InteractiveBrokersOrderCondition.AuctionStrategies? AuctionStrategy { get; set; }

Property Value

InteractiveBrokersOrderCondition.AuctionStrategies?

Remarks

Only BOX board.

AutoCancelDate

Auto cancel date.

public string AutoCancelDate { get; set; }

Property Value

string

AutoCancelParent

Auto cancel parent.

public bool? AutoCancelParent { get; set; }

Property Value

bool?

CashQty

The native cash quantity.

public decimal? CashQty { get; set; }

Property Value

decimal?

Clearing

Condition for clearing information.

[TypeConverter(typeof(ExpandableObjectConverter))]
public InteractiveBrokersOrderCondition.ClearingCondition Clearing { get; }

Property Value

InteractiveBrokersOrderCondition.ClearingCondition

Combo

EFP orders settings.

[TypeConverter(typeof(ExpandableObjectConverter))]
public InteractiveBrokersOrderCondition.ComboCondition Combo { get; }

Property Value

InteractiveBrokersOrderCondition.ComboCondition

CompeteAgainstBestOffset

Specifies the offset Off The Midpoint that will be applied to the order.

public decimal? CompeteAgainstBestOffset { get; set; }

Property Value

decimal?

ConditionsCancelOrder

Conditions can determine if an order should become active or canceled.

public bool ConditionsCancelOrder { get; set; }

Property Value

bool

ConditionsIgnoreRth

Indicates whether or not conditions will also be valid outside Regular Trading Hours.

public bool ConditionsIgnoreRth { get; set; }

Property Value

bool

CustomerAccount

Customer account.

public string CustomerAccount { get; set; }

Property Value

string

Delta

Underlying asset delta.

public decimal? Delta { get; set; }

Property Value

decimal?

Remarks

Only BOX board.

DiscretionaryUpToLimitPrice

Convert order of type 'Primary Peg' to 'D-Peg'.

public bool DiscretionaryUpToLimitPrice { get; set; }

Property Value

bool

DontUseAutoPriceForHedge

Don't use auto price for hedge

public bool DontUseAutoPriceForHedge { get; set; }

Property Value

bool

Duration

Duration.

public int? Duration { get; set; }

Property Value

int?

ExtOperator

Regulatory attribute that applies to all US Commodity (Futures) Exchanges, provided to allow client to comply with CFTC Tag 50 Rules.

[Display(ResourceType = typeof(LocalizedStrings), Name = "Operator", Description = "Operator", GroupName = "Parameter")]
public string ExtOperator { get; set; }

Property Value

string

ExtendedType

Extended condition.

[Display(ResourceType = typeof(LocalizedStrings), Name = "ExtraConditions", Description = "ExtraConditionsDesc", GroupName = "Parameter")]
public InteractiveBrokersOrderCondition.ExtendedOrderTypes? ExtendedType { get; set; }

Property Value

InteractiveBrokersOrderCondition.ExtendedOrderTypes?

ExtraConditions

Extra conditions.

[Display(ResourceType = typeof(LocalizedStrings), Name = "Parameters", Description = "Parameters", GroupName = "Parameter")]
public IEnumerable<InteractiveBrokersOrderCondition.ExtraOrderCondition> ExtraConditions { get; set; }

Property Value

IEnumerable<InteractiveBrokersOrderCondition.ExtraOrderCondition>

FinancialAdvisor

Settings for automatic order volume calculation.

[TypeConverter(typeof(ExpandableObjectConverter))]
public InteractiveBrokersOrderCondition.FinancialAdvisorCondition FinancialAdvisor { get; }

Property Value

InteractiveBrokersOrderCondition.FinancialAdvisorCondition

GoodAfterTime

Activate after given time.

public DateTimeOffset? GoodAfterTime { get; set; }

Property Value

DateTimeOffset?

Hedge

Condition for hedge-orders.

[TypeConverter(typeof(ExpandableObjectConverter))]
public InteractiveBrokersOrderCondition.HedgeCondition Hedge { get; }

Property Value

InteractiveBrokersOrderCondition.HedgeCondition

Hidden

Hide order in market depth.

public bool? Hidden { get; set; }

Property Value

bool?

Remarks

It is possible only when the order is sending to the ISLAND exchange.

ImbalanceOnly

Imbalance only.

public bool? ImbalanceOnly { get; set; }

Property Value

bool?

IsMarketOnOpen

At trading opening.

public bool? IsMarketOnOpen { get; set; }

Property Value

bool?

IsOmsContainer

Create tickets from API orders when TWS is used as an OMS.

public bool IsOmsContainer { get; set; }

Property Value

bool

IsOpenOrClose

Is the order opening or closing.

public bool? IsOpenOrClose { get; set; }

Property Value

bool?

Remarks

Only for institutional clients.

IsOptionsExercise

Exercise the option.

public bool IsOptionsExercise { get; set; }

Property Value

bool

IsOptionsOverride

Replace action.

public bool IsOptionsOverride { get; set; }

Property Value

bool

IsPeggedChangeAmountDecrease

Pegged-to-benchmark orders: indicates whether the order's pegged price should increase or decreases.

public bool? IsPeggedChangeAmountDecrease { get; set; }

Property Value

bool?

LimitPriceOffset 

public decimal? LimitPriceOffset { get; set; }

Property Value

decimal?

ManualOrderTime

Used by brokers and advisors when manually entering, modifying or cancelling orders at the direction of a client.

public DateTimeOffset? ManualOrderTime { get; set; }

Property Value

DateTimeOffset?

MidOffsetAtHalf

This offset is applied when the spread is an odd number of cents wide. This offset must be in half-penny increments.

public decimal? MidOffsetAtHalf { get; set; }

Property Value

decimal?

MidOffsetAtWhole

This offset is applied when the spread is an even number of cents wide. This offset must be in whole-penny increments or zero.

public decimal? MidOffsetAtWhole { get; set; }

Property Value

decimal?

Mifid2DecisionAlgo

Identifies the algorithm responsible for investment decisions within the firm. Orders covered under MiFID 2 must include either Mifid2DecisionMaker or Mifid2DecisionAlgo, but cannot have both.

public string Mifid2DecisionAlgo { get; set; }

Property Value

string

Mifid2DecisionMaker

Identifies a person as the responsible party for investment decisions within the firm. Orders covered by MiFID 2 (Markets in Financial Instruments Directive 2) must include either Mifid2DecisionMaker or Mifid2DecisionAlgo field (but not both).

public string Mifid2DecisionMaker { get; set; }

Property Value

string

Mifid2ExecutionAlgo

For MiFID 2 reporting: identifies the algorithm responsible for the execution of a transaction within the firm.

public string Mifid2ExecutionAlgo { get; set; }

Property Value

string

Mifid2ExecutionTrader

For MiFID 2 reporting: identifies a person as the responsible party for the execution of a transaction within the firm.

public string Mifid2ExecutionTrader { get; set; }

Property Value

string

MinCompeteSize

Defines the minimum size to compete.

public int? MinCompeteSize { get; set; }

Property Value

int?

MinTradeQty

Defines the minimum trade quantity to fill.

public int? MinTradeQty { get; set; }

Property Value

int?

MiscOptions

Additional parameters.

[Display(ResourceType = typeof(LocalizedStrings), Name = "Parameters", Description = "Parameters", GroupName = "Parameter")]
public IEnumerable<Tuple<string, string>> MiscOptions { get; set; }

Property Value

IEnumerable<Tuple<string, string>>

Oca

OCA (One-Cancels All) settings.

[TypeConverter(typeof(ExpandableObjectConverter))]
public InteractiveBrokersOrderCondition.OcaCondition Oca { get; }

Property Value

InteractiveBrokersOrderCondition.OcaCondition

Origin

Sender.

[Display(ResourceType = typeof(LocalizedStrings), Name = "Sender", Description = "Sender", GroupName = "Parameter")]
public InteractiveBrokersOrderCondition.OrderOrigins? Origin { get; set; }

Property Value

InteractiveBrokersOrderCondition.OrderOrigins?

Remarks

Only for institutional clients.

OutsideRth

Allow to activate a stop-order outside of trading time.

public bool? OutsideRth { get; set; }

Property Value

bool?

OverridePercentageConstraints

Cancel orders with wrong price.

public bool? OverridePercentageConstraints { get; set; }

Property Value

bool?

ParentId

Parent order ID.

public int? ParentId { get; set; }

Property Value

int?

ParentPermId

Parent perm id.

public long? ParentPermId { get; set; }

Property Value

long?

PeggedChangeAmount

Pegged-to-benchmark orders: amount by which the order's pegged price should move.

public decimal? PeggedChangeAmount { get; set; }

Property Value

decimal?

PercentOffset

The shift in the price for the order type Relative.

public decimal? PercentOffset { get; set; }

Property Value

decimal?

PostToAts

Reroute to SMART for IBKR ATS orders.

public int? PostToAts { get; set; }

Property Value

int?

ProfessionalCustomer

Professional customer.

public bool? ProfessionalCustomer { get; set; }

Property Value

bool?

RandomizePrice

Randomize price books.

[Display(ResourceType = typeof(LocalizedStrings), Name = "RandomizePrice", Description = "RandomizePrice", GroupName = "Parameter")]
public bool? RandomizePrice { get; set; }

Property Value

bool?

RandomizeSize

Randomize size.

[Display(ResourceType = typeof(LocalizedStrings), Name = "RandomizeSize", Description = "RandomizeSize", GroupName = "Parameter")]
public bool? RandomizeSize { get; set; }

Property Value

bool?

RefFuturesContractId

Futures contract id.

public int? RefFuturesContractId { get; set; }

Property Value

int?

ReferenceChangeAmount

Pegged-to-benchmark orders: the amount the reference contract needs to move to adjust the pegged order.

public decimal? ReferenceChangeAmount { get; set; }

Property Value

decimal?

ReferenceContractId

Pegged-to-benchmark orders: this attribute will contain the conId of the contract against which the order will be pegged.

public int? ReferenceContractId { get; set; }

Property Value

int?

ReferenceExchange

Pegged-to-benchmark orders: the exchange against which we want to observe the reference contract.

public string ReferenceExchange { get; set; }

Property Value

string

RouteMarketableToBbo

Route marketable to bbo.

public bool? RouteMarketableToBbo { get; set; }

Property Value

bool?

Scale

Condition for order being changed.

[TypeConverter(typeof(ExpandableObjectConverter))]
public InteractiveBrokersOrderCondition.ScaleCondition Scale { get; }

Property Value

InteractiveBrokersOrderCondition.ScaleCondition

Shareholder

Shareholder.

public string Shareholder { get; set; }

Property Value

string

ShortSale

Condition for short sales of combined legs.

[Display(ResourceType = typeof(LocalizedStrings), Name = "ShortSaleConditions", Description = "ShortSaleConditions", GroupName = "Parameter")]
[TypeConverter(typeof(ExpandableObjectConverter))]
public InteractiveBrokersOrderCondition.ShortSaleCondition ShortSale { get; }

Property Value

InteractiveBrokersOrderCondition.ShortSaleCondition

SmartRouting

Settings for orders that are sent to the Smart exchange.

[TypeConverter(typeof(ExpandableObjectConverter))]
public InteractiveBrokersOrderCondition.SmartRoutingCondition SmartRouting { get; }

Property Value

InteractiveBrokersOrderCondition.SmartRoutingCondition

Solicited

Solicited.

[Display(ResourceType = typeof(LocalizedStrings), Name = "Solicited", Description = "Solicited", GroupName = "Parameter")]
public bool? Solicited { get; set; }

Property Value

bool?

SplitVolume

Split order volume.

public bool? SplitVolume { get; set; }

Property Value

bool?

StartingPrice

Starting price.

public decimal? StartingPrice { get; set; }

Property Value

decimal?

Remarks

Only BOX board.

StockRangeLower

Minimum price of underlying asset.

public decimal? StockRangeLower { get; set; }

Property Value

decimal?

StockRangeUpper

Maximum price of underlying asset.

public decimal? StockRangeUpper { get; set; }

Property Value

decimal?

StockRefPrice

Underlying asset price.

[Display(ResourceType = typeof(LocalizedStrings), Name = "UnderlyingAssetPrice", Description = "UnderlyingAssetPrice", GroupName = "Parameter")]
public decimal? StockRefPrice { get; set; }

Property Value

decimal?

StopPrice

Stop-price.

[Display(ResourceType = typeof(LocalizedStrings), Name = "StopPrice", Description = "StopPriceValue", GroupName = "Parameter")]
public decimal? StopPrice { get; set; }

Property Value

decimal?

SweepToFill

At best price.

[Display(ResourceType = typeof(LocalizedStrings), Name = "AtBestPrice", Description = "AtBestPrice", GroupName = "Parameter")]
public bool? SweepToFill { get; set; }

Property Value

bool?

Tier

Define the Soft Dollar Tier used for the order. Only provided for registered professional advisors and hedge and mutual funds.

public SoftDollarTier Tier { get; set; }

Property Value

SoftDollarTier

TrailStopPrice

Moving stop activation price.

[Display(ResourceType = typeof(LocalizedStrings), Name = "StopPrice", Description = "StopPrice", GroupName = "Parameter")]
public decimal? TrailStopPrice { get; set; }

Property Value

decimal?

TrailStopVolumePercentage

Trailing stop volume as percentage.

public decimal? TrailStopVolumePercentage { get; set; }

Property Value

decimal?

Transmit

Send order in TWS.

public bool? Transmit { get; set; }

Property Value

bool?

TriggerMethod

Stop-order activation condition.

public InteractiveBrokersOrderCondition.TriggerMethods? TriggerMethod { get; set; }

Property Value

InteractiveBrokersOrderCondition.TriggerMethods?

TriggerPrice 

public decimal? TriggerPrice { get; set; }

Property Value

decimal?

UsePriceManagementAlgo

Use price management algorithm.

public bool? UsePriceManagementAlgo { get; set; }

Property Value

bool?

Volatility

The settings for the orders type Volatility.

[TypeConverter(typeof(ExpandableObjectConverter))]
public InteractiveBrokersOrderCondition.VolatilityCondition Volatility { get; }

Property Value

InteractiveBrokersOrderCondition.VolatilityCondition

WhatIf

For order return information about commission and margin.

public bool? WhatIf { get; set; }

Property Value

bool?