truefix-twsapi-client 0.1.4

Thin Interactive Brokers TWS/Gateway protocol client for TrueFix.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216

/* Copyright (C) 2025 Interactive Brokers LLC. All rights reserved. This code is subject to the terms
 * and conditions of the IB API Non-Commercial License or the IB API Commercial License, as applicable. */

syntax = "proto3";

package protobuf;

import "OrderCondition.proto";
import "SoftDollarTier.proto";

option java_outer_classname = "OrderProto";
option java_package = "com.ib.client.protobuf";
option csharp_namespace = "IBApi.protobuf";

message Order {

    // order ids
    optional int32 clientId = 1;
    optional int32 orderId = 2;
    optional int64 permId = 3;
    optional int32 parentId = 4;

    // primary attributes
    optional string action = 5;
    optional string totalQuantity = 6;
    optional int32 displaySize = 7;
    optional string orderType = 8;
    optional double lmtPrice = 9;
    optional double auxPrice = 10;
    optional string tif = 11;

    // clearing info
    optional string account = 12;
    optional string settlingFirm = 13;
    optional string clearingAccount = 14;
    optional string clearingIntent = 15;

    // secondary attributes
    optional bool allOrNone = 16;
    optional bool blockOrder = 17;
    optional bool hidden = 18;
    optional bool outsideRth = 19;
    optional bool sweepToFill = 20;
    optional double percentOffset = 21;
    optional double trailingPercent = 22;
    optional double trailStopPrice = 23;
    optional int32 minQty = 24;
    optional string goodAfterTime = 25;
    optional string goodTillDate = 26;
    optional string ocaGroup = 27;
    optional string orderRef = 28;
    optional string rule80A = 29;
    optional int32 ocaType = 30;
    optional int32 triggerMethod = 31;

    // extended order fields
    optional string activeStartTime = 32;
    optional string activeStopTime = 33;

    // advisor allocation orders
    optional string faGroup = 34;
    optional string faMethod = 35;
    optional string faPercentage = 36;

    // volatility orders
    optional double volatility = 37;
    optional int32 volatilityType = 38;
    optional bool continuousUpdate = 39;
    optional int32 referencePriceType = 40;
    optional string deltaNeutralOrderType = 41;
    optional double deltaNeutralAuxPrice = 42;
    optional int32 deltaNeutralConId = 43;
    optional string deltaNeutralOpenClose = 44;
    optional bool deltaNeutralShortSale = 45;
    optional int32 deltaNeutralShortSaleSlot = 46;
    optional string deltaNeutralDesignatedLocation = 47;

    // scale orders
    optional int32 scaleInitLevelSize = 48;
    optional int32 scaleSubsLevelSize = 49;
    optional double scalePriceIncrement = 50;
    optional double scalePriceAdjustValue = 51;
    optional int32 scalePriceAdjustInterval = 52;
    optional double scaleProfitOffset = 53;
    optional bool scaleAutoReset = 54;
    optional int32 scaleInitPosition = 55;
    optional int32 scaleInitFillQty = 56;
    optional bool scaleRandomPercent = 57;
    optional string scaleTable = 58;

    // hedge orders
    optional string hedgeType = 59;
    optional string hedgeParam = 60;

    // algo orders
    optional string algoStrategy = 61;
    map<string, string> algoParams = 62;
    optional string algoId = 63;

    // combo orders
    map<string, string> smartComboRoutingParams = 64;

    // processing control
    optional bool whatIf = 65;
    optional bool transmit = 66;
    optional bool overridePercentageConstraints = 67;

    // Institutional orders only
    optional string openClose = 68;
    optional int32 origin = 69;
    optional int32 shortSaleSlot = 70;
    optional string designatedLocation = 71;
    optional int32 exemptCode = 72;
    optional string deltaNeutralSettlingFirm = 73;
    optional string deltaNeutralClearingAccount = 74;
    optional string deltaNeutralClearingIntent = 75;

    // SMART routing only
    optional double discretionaryAmt = 76;
    optional bool optOutSmartRouting = 77;

    // BOX ORDERS ONLY
    optional double startingPrice = 78;
    optional double stockRefPrice = 79;
    optional double delta = 80;

    // pegged to stock or VOL orders
    optional double stockRangeLower = 81;
    optional double stockRangeUpper = 82;

    // Not Held
    optional bool notHeld = 83;

    // order misc options
    map<string, string> orderMiscOptions = 84;

    //order algo id
    optional bool solicited = 85;

    optional bool randomizeSize = 86;
    optional bool randomizePrice = 87;

    // PEG2BENCH fields
    optional int32 referenceContractId = 88;
    optional double peggedChangeAmount = 89;
    optional bool isPeggedChangeAmountDecrease = 90;
    optional double referenceChangeAmount = 91;
    optional string referenceExchangeId = 92;
    optional string adjustedOrderType = 93;
    optional double triggerPrice = 94;
    optional double adjustedStopPrice = 95;
    optional double adjustedStopLimitPrice = 96;
    optional double adjustedTrailingAmount = 97;
    optional int32 adjustableTrailingUnit = 98;
    optional double lmtPriceOffset = 99;

    repeated OrderCondition conditions = 100;
    optional bool conditionsCancelOrder = 101;
    optional bool conditionsIgnoreRth = 102;

    // models
    optional string modelCode = 103;

    optional string extOperator = 104;

    optional SoftDollarTier softDollarTier = 105;

    // native cash quantity
    optional double cashQty = 106;

    optional string mifid2DecisionMaker = 107;
    optional string mifid2DecisionAlgo = 108;
    optional string mifid2ExecutionTrader = 109;
    optional string mifid2ExecutionAlgo = 110;

    // don't use auto price for hedge
    optional bool dontUseAutoPriceForHedge = 111;

    optional bool isOmsContainer = 112;
    optional bool discretionaryUpToLimitPrice = 113;

    optional string autoCancelDate = 114;
    optional string filledQuantity = 115;
    optional int32 refFuturesConId = 116;
    optional bool autoCancelParent = 117;
    optional string shareholder = 118;
    optional bool imbalanceOnly = 119;
    optional int32 routeMarketableToBbo = 120;
    optional int64 parentPermId = 121;

    optional int32 usePriceMgmtAlgo = 122;
    optional int32 duration = 123;
    optional int32 postToAts = 124;
    optional string advancedErrorOverride = 125;
    optional string manualOrderTime = 126;
    optional int32 minTradeQty = 127;
    optional int32 minCompeteSize = 128;
    optional double competeAgainstBestOffset = 129;
    optional double midOffsetAtWhole = 130;
    optional double midOffsetAtHalf = 131;
    optional string customerAccount = 132;
    optional bool professionalCustomer = 133;
    optional string bondAccruedInterest = 134;
    optional bool includeOvernight = 135;
    optional int32 manualOrderIndicator = 136;
    optional string submitter = 137;
    optional bool deactivate = 138;
    optional bool postOnly = 139;
    optional bool allowPreOpen = 140;
    optional bool ignoreOpenAuction = 141;
    optional int32 seekPriceImprovement = 142;
    optional int32 whatIfType = 143;

    // hedge orders
    optional int32 hedgeMaxSize = 144;
}