{"id":8098,"date":"2025-09-04T23:21:37","date_gmt":"2025-09-05T04:21:37","guid":{"rendered":"https:\/\/librarytestdev.wpenginepowered.com\/?post_type=doc&p=8098"},"modified":"2025-09-04T23:23:48","modified_gmt":"2025-09-05T04:23:48","slug":"launching-an-algo","status":"publish","type":"doc","link":"https:\/\/library-staging.tradingtechnologies.com\/apis\/tt-net-sdk\/working-with-algos\/algo-server\/launching-an-algo\/","title":{"rendered":"Launching an algo"},"content":{"rendered":"\n

Construct an OrderProfile<\/h2>\n\n\n\n

Algos are treated in the same way as exchange native orders in TT. As such, to launch an algo, you need to create an OrderProfile<\/a> instance. An algo\u2019s OrderProfile<\/a> instance must be created from the AlgoLookup<\/a> instance by calling the Algo.GetOrderProfile()<\/a> method. This method has two overloads.<\/p>\n\n\n\n

OrderProfile GetOrderProfile();\nOrderProfile GetOrderProfile(Instrument);\n<\/code><\/pre>\n\n\n\n
<\/a>Set the algo parameters<\/h2>\n\n\n\n
If your algo has a parameter with “Name” = “Instrument” and “FieldLocation” = “OrderProfile”, then you must use the second of these. All TT Algos have such a parameter as do ADL algos that have declared one of its required instrument inputs as an Order Instrument<\/strong>. Otherwise, you use the first of these.<\/p>\n\n\n\n
\"\"\/<\/figure>\n\n\n\n
You then set the rest of the parameters in the OrderProfile<\/a>. Some of the parameters are set using specific OrderProfile<\/a> properties and some are set in the UserParameters<\/a> collection as shown below. Specifically, if the “FieldLocation” of a parameter is equal to “OrderProfile”, then the parameter is set on the OrderProfile<\/a> instance directly via the property indicated by its “Name”. If the “FieldLocation” is equal to “UserParameters”, then the parameter is set as part of the UserParameters<\/a> property of the OrderProfile<\/a> instance.<\/p>\n\n\n\n
For example, the following are the parameters of the TT Stop algo.<\/p>\n\n\n
Name<\/th>Type<\/th>Required<\/th>Updatable<\/th>FieldLocation<\/th>Algo-Specific Enum<\/th><\/tr><\/thead>
OrderInstrumentID<\/td>Instrument<\/td>true<\/td>true<\/td>OrderProfile<\/a><\/td><\/td><\/tr>
OrderQty<\/td>Quantity<\/td>true<\/td>false<\/td>OrderProfile<\/a><\/td><\/td><\/tr>
OrderSide<\/td>Enum<\/td>true<\/td>false<\/td>OrderProfile<\/a><\/td>tt_net_sdk.OrderSide<\/a><\/td><\/tr>
OrderAccount<\/td>String<\/td>true<\/td>false<\/td>OrderProfile<\/a><\/td><\/td><\/tr>
TriggerPrice<\/td>Price<\/td>false<\/td>true<\/td>OrderProfile<\/a><\/td><\/td><\/tr>
OrderType<\/td>Enum<\/td>true<\/td>false<\/td>OrderProfile<\/a><\/td>tt_net_sdk.OrderType<\/a><\/td><\/tr>
LimitPrice<\/td>Price<\/td>true<\/td>true<\/td>OrderProfile<\/a><\/td><\/td><\/tr>
ChildTIF<\/td>Int_t<\/td>true<\/td>false<\/td>UserParameters<\/a><\/td><\/td><\/tr>
ParentTIF<\/td>Int_t<\/td>true<\/td>false<\/td>UserParameters<\/a><\/td>tt_net_sdk.tt_stop.ParentTIF<\/a><\/td><\/tr>
TriggerPriceType<\/td>Int_t<\/td>true<\/td>false<\/td>UserParameters<\/a><\/td>tt_net_sdk.tt_stop.TriggerPriceType<\/a><\/td><\/tr>
IsTrlTrg<\/td>Boolean_t<\/td>false<\/td>false<\/td>UserParameters<\/a><\/td><\/td><\/tr>
TriggerTicksAway<\/td>Int_t<\/td>false<\/td>true<\/td>UserParameters<\/a><\/td><\/td><\/tr>
TriggerQtyType<\/td>Int_t<\/td>false<\/td>false<\/td>UserParameters<\/a><\/td>tt_net_sdk.tt_stop.TriggerQtyType<\/a><\/td><\/tr>
TriggerQtyCompare<\/td>Int_t<\/td>false<\/td>false<\/td>UserParameters<\/a><\/td>tt_net_sdk.tt_stop.TriggerQtyCompare<\/a><\/td><\/tr>
TriggerQty<\/td>Qty_t<\/td>false<\/td>true<\/td>UserParameters<\/a><\/td><\/td><\/tr>
SecondConditionIsOn<\/td>Boolean_t<\/td>false<\/td>false<\/td>UserParameters<\/a><\/td><\/td><\/tr>
SecondTriggerPriceType<\/td>Int_t<\/td>true<\/td>false<\/td>UserParameters<\/a><\/td>tt_net_sdk.tt_stop.SecondTriggerPriceType<\/a><\/td><\/tr>
SecondTriggerTicksAway<\/td>Int_t<\/td>false<\/td>true<\/td>UserParameters<\/a><\/td><\/td><\/tr>
SecondTriggerQtyType<\/td>Int_t<\/td>false<\/td>false<\/td>UserParameters<\/a><\/td>tt_net_sdk.tt_stop.SecondTriggerQtyType<\/a><\/td><\/tr>
SecondTriggerQtyCompare<\/td>Int_t<\/td>false<\/td>false<\/td>UserParameters<\/a><\/td>tt_net_sdk.tt_stop.SecondTriggerQtyCompare<\/a><\/td><\/tr>
SecondTriggerQty<\/td>Qty_t<\/td>false<\/td>true<\/td>UserParameters<\/a><\/td><\/td><\/tr>
TriggerLTPReset<\/td>Boolean_t<\/td>false<\/td>false<\/td>UserParameters<\/a><\/td><\/td><\/tr>
Payup<\/td>Int_t<\/td>false<\/td>true<\/td>UserParameters<\/a><\/td><\/td><\/tr>
LimitPriceType<\/td>Int_t<\/td>false<\/td>false<\/td>UserParameters<\/a><\/td>tt_net_sdk.tt_stop.LimitPriceType<\/a><\/td><\/tr>
WithATickType<\/td>Int_t<\/td>false<\/td>false<\/td>UserParameters<\/a><\/td>tt_net_sdk.tt_stop.WithATickType<\/a><\/td><\/tr>
WithATick<\/td>Qty_t<\/td>false<\/td>true<\/td>UserParameters<\/a><\/td><\/td><\/tr>
STime<\/td>UTCTimestamp_t<\/td>false<\/td>true<\/td>UserParameters<\/a><\/td><\/td><\/tr>
ETime<\/td>UTCTimestamp_t<\/td>false<\/td>true<\/td>UserParameters<\/a><\/td><\/td><\/tr>
ETimeAct<\/td>Int_t<\/td>false<\/td>false<\/td>UserParameters<\/a><\/td>tt_net_sdk.tt_stop.ETimeAct<\/a><\/td><\/tr>
NoImplies<\/td>Boolean_t<\/td>false<\/td>false<\/td>UserParameters<\/a><\/td><\/td><\/tr>
AutoResubExpiredGTD<\/td>Boolean_t<\/td>false<\/td>false<\/td>UserParameters<\/a><\/td><\/td><\/tr>
WaitingOption<\/td>Int_t<\/td>true<\/td>false<\/td>UserParameters<\/a><\/td>tt_net_sdk.tt_stop.WaitingOption<\/a><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
<\/a>Set the User Disconnect Action<\/h2>\n\n\n\n
When your application launches an ADL algo, TT monitors the connection from your application to the TT ecosystem. If TT detects that your application has disconnected, you can specify the action to be taken on your algo. This can be done by specifying a single action for all algos when you initialize the API as follows.<\/p>\n\n\n\n
string appSecretKey = \"Your App Key\";\ntt_net_sdk.ServiceEnvironment environment = tt_net_sdk.ServiceEnvironment.UatCert;\ntt_net_sdk.TTAPIOptions apiConfig = new tt_net_sdk.TTAPIOptions(\n\t\t\tenvironment,\n\t\t\tappSecretKey,\n\t\t\t5000);\napiConfig.UserDisconnectAction = UserDisconnectAction.Cancel;\n<\/code><\/pre>\n\n\n\n
You can also specify this behavior on a per algo basis by setting the UserDisconnectAction<\/a> property of the OrderProfile<\/a> instance.<\/p>\n\n\n\n
\/\/ Assume that the name of your OrderProfile object is \u2018op\u2019\nop.UserDisconnectAction = UserDisconnectAction.Pause;\n<\/code><\/pre>\n\n\n\n
<\/a>Set the co-location facility<\/h2>\n\n\n\n
TT has a pool of Algo Servers in each major data center. You must specify in which data center that you want your algo to execute as follows.<\/p>\n\n\n\n
\/\/ Assume that the name of your OrderProfile object is \u2018op\u2019\nop.CoLocation = MarketId.CME;\n<\/code><\/pre>\n\n\n\n
<\/a>Launch the algo<\/h2>\n\n\n\n
Once your OrderProfile<\/a> is ready, you can launch an algo by calling the SendOrder()<\/a> method of the AlgoTradeSubscription<\/a> instance. The following code snippet demonstrates the launching of the TT Stop algo.<\/p>\n\n\n\n
private InstrumentLookup m_instrLookupRequest = null;\nprivate Instrument m_inst = null;\n\nprivate void m_ats_OrderBookDownload(object sender, OrderBookDownloadEventArgs e)\n{\n\tm_instrLookupRequest = new InstrumentLookup(\n\t   tt_net_sdk.Dispatcher.Current,\n\t   MarketId.CME, \n\t   ProductType.Future,\n\t   \"ES\", \n\t   \"ES Dec19\");\n\n\tProductDataEvent ev = m_instrLookupRequest.Get();\n\tif (ev == ProductDataEvent.Found)\n\t{\n\t\t\/\/ Instrument was found\n\t\tm_inst = m_instrLookupRequest.Instrument;\n\n\t\tOrderProfile op = m_alookup.Algo.GetOrderProfile(m_inst);\n\n\t\tDictionary<string, object> userparams = new Dictionary<string, object>\n\t\t{\n\t\t\t{\"TriggerPriceType\", tt_net_sdk.tt_stop.TriggerPriceType.Ltp },\n\t\t\t{\"ChildTIF\" ,        tt_net_sdk.TimeInForce.Day  },\n\t\t\t{\"ParentTIF\" ,       tt_net_sdk.tt_stop.ParentTIF.Day },\n\t\t};\n\n\t\top.UserParameters = userparams;\n\n\t\top.AccountName = \"ATRcert\";\n\t\top.Side = OrderSide.Buy;\n\t\top.OrderType = OrderType.Limit;\n\t\top.OrderQuantity = Quantity.FromDecimal(m_inst, 10);\n\t\top.TriggerPrice = Price.FromString(m_inst, \"2887.00\");\n\t\top.LimitPrice = Price.FromString(m_inst, \"2887.50\");\n\n\t\tif (!m_ats.SendOrder(op))\n\t\t{\n\t\t\tConsole.WriteLine(\"Launch algo Failed.\");\n\t\t}\n\t\telse\n\t\t{\n\t\t\tConsole.WriteLine(\"Launched new algo: \" + \" SOK=\" + op.SiteOrderKey);\n\t\t}\n\t}\n\telse\n\t{\n\t\t\/\/ Instrument was not found\n\t\tConsole.WriteLine(\"Cannot find instrument: {0}\", ev.ToString());\n\t\treturn;\n\t}\n}\n<\/code><\/pre>\n\n\n\n
<\/a>Pause and resume ADL algos<\/h2>\n\n\n\n
ADL algos can be paused and then resumed. To accomplish this through the API, you simply set the OrderAction<\/a> to the appropriate value as follows.<\/p>\n\n\n\n
OrderProfile op  = new OrderProfile(e.Fields.Instrument);\nop.Action = OrderAction.Pause;\n\nOrderProfile op  = new OrderProfile(e.Fields.Instrument);\nop.Action = OrderAction.Resume;<\/code><\/pre>\n","protected":false},"excerpt":{"rendered":"
Construct an OrderProfile<\/h2>\n
Algos are treated in the same way as exchange native orders in TT. As such, to launch an algo, you need to create an OrderProfile<\/a> instance. An algo\u2019s OrderProfile<\/a> instance must be created from the AlgoLookup<\/a> instance by calling the Algo.GetOrderProfile()<\/a> method. This method has two overloads.<\/p>\n
<\/a>Set the algo parameters<\/h2>\n
If your algo has a parameter with “Name” = “Instrument” and “FieldLocation” = “OrderProfile”, then you must use the second of these. All TT Algos have such a parameter as do ADL algos that have declared one of its required instrument inputs as an Order Instrument<\/strong>. Otherwise, you use the first of these.<\/p>\n
You then set the rest of the parameters in the OrderProfile<\/a>. Some of the parameters are set using specific OrderProfile<\/a> properties and some are set in the UserParameters<\/a> collection as shown below. Specifically, if the “FieldLocation” of a parameter is equal to “OrderProfile”, then the parameter is set on the OrderProfile<\/a> instance directly via the property indicated by its “Name”. If the “FieldLocation” is equal to “UserParameters”, then the parameter is set as part of the UserParameters<\/a> property of the OrderProfile<\/a> instance.<\/p>\n
For example, the following are the parameters of the TT Stop algo.<\/p>\n
<\/p>\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Name<\/th>\nType<\/th>\nRequired<\/th>\nUpdatable<\/th>\nFieldLocation<\/th>\nAlgo-Specific Enum<\/th>\n<\/tr>\n<\/thead>\n
OrderInstrumentID<\/td>\nInstrument<\/td>\ntrue<\/td>\ntrue<\/td>\nOrderProfile<\/a><\/td>\n<\/td>\n<\/tr>\n
OrderQty<\/td>\nQuantity<\/td>\ntrue<\/td>\nfalse<\/td>\nOrderProfile<\/a><\/td>\n<\/td>\n<\/tr>\n
OrderSide<\/td>\nEnum<\/td>\ntrue<\/td>\nfalse<\/td>\nOrderProfile<\/a><\/td>\ntt_net_sdk.OrderSide<\/a><\/td>\n<\/tr>\n
OrderAccount<\/td>\nString<\/td>\ntrue<\/td>\nfalse<\/td>\nOrderProfile<\/a><\/td>\n<\/td>\n<\/tr>\n
TriggerPrice<\/td>\nPrice<\/td>\nfalse<\/td>\ntrue<\/td>\nOrderProfile<\/a><\/td>\n<\/td>\n<\/tr>\n
OrderType<\/td>\nEnum<\/td>\ntrue<\/td>\nfalse<\/td>\nOrderProfile<\/a><\/td>\ntt_net_sdk.OrderType<\/a><\/td>\n<\/tr>\n
LimitPrice<\/td>\nPrice<\/td>\ntrue<\/td>\ntrue<\/td>\nOrderProfile<\/a><\/td>\n<\/td>\n<\/tr>\n
ChildTIF<\/td>\nInt_t<\/td>\ntrue<\/td>\nfalse<\/td>\nUserParameters<\/a><\/td>\n<\/td>\n<\/tr>\n
ParentTIF<\/td>\nInt_t<\/td>\ntrue<\/td>\nfalse<\/td>\nUserParameters<\/a><\/td>\ntt_net_sdk.tt_stop.ParentTIF<\/a><\/td>\n<\/tr>\n
TriggerPriceType<\/td>\nInt_t<\/td>\ntrue<\/td>\nfalse<\/td>\nUserParameters<\/a><\/td>\ntt_net_sdk.tt_stop.TriggerPriceType<\/a><\/td>\n<\/tr>\n
IsTrlTrg<\/td>\nBoolean_t<\/td>\nfalse<\/td>\nfalse<\/td>\nUserParameters<\/a><\/td>\n<\/td>\n<\/tr>\n
TriggerTicksAway<\/td>\nInt_t<\/td>\nfalse<\/td>\ntrue<\/td>\nUserParameters<\/a><\/td>\n<\/td>\n<\/tr>\n
TriggerQtyType<\/td>\nInt_t<\/td>\nfalse<\/td>\nfalse<\/td>\nUserParameters<\/a><\/td>\ntt_net_sdk.tt_stop.TriggerQtyType<\/a><\/td>\n<\/tr>\n
TriggerQtyCompare<\/td>\nInt_t<\/td>\nfalse<\/td>\nfalse<\/td>\nUserParameters<\/a><\/td>\ntt_net_sdk.tt_stop.TriggerQtyCompare<\/a><\/td>\n<\/tr>\n
TriggerQty<\/td>\nQty_t<\/td>\nfalse<\/td>\ntrue<\/td>\nUserParameters<\/a><\/td>\n<\/td>\n<\/tr>\n
SecondConditionIsOn<\/td>\nBoolean_t<\/td>\nfalse<\/td>\nfalse<\/td>\nUserParameters<\/a><\/td>\n<\/td>\n<\/tr>\n
SecondTriggerPriceType<\/td>\nInt_t<\/td>\ntrue<\/td>\nfalse<\/td>\nUserParameters<\/a><\/td>\ntt_net_sdk.tt_stop.SecondTriggerPriceType<\/a><\/td>\n<\/tr>\n
SecondTriggerTicksAway<\/td>\nInt_t<\/td>\nfalse<\/td>\ntrue<\/td>\nUserParameters<\/a><\/td>\n<\/td>\n<\/tr>\n
SecondTriggerQtyType<\/td>\nInt_t<\/td>\nfalse<\/td>\nfalse<\/td>\nUserParameters<\/a><\/td>\ntt_net_sdk.tt_stop.SecondTriggerQtyType<\/a><\/td>\n<\/tr>\n
SecondTriggerQtyCompare<\/td>\nInt_t<\/td>\nfalse<\/td>\nfalse<\/td>\nUserParameters<\/a><\/td>\ntt_net_sdk.tt_stop.SecondTriggerQtyCompare<\/a><\/td>\n<\/tr>\n
SecondTriggerQty<\/td>\nQty_t<\/td>\nfalse<\/td>\ntrue<\/td>\nUserParameters<\/a><\/td>\n<\/td>\n<\/tr>\n
TriggerLTPReset<\/td>\nBoolean_t<\/td>\nfalse<\/td>\nfalse<\/td>\nUserParameters<\/a><\/td>\n<\/td>\n<\/tr>\n
Payup<\/td>\nInt_t<\/td>\nfalse<\/td>\ntrue<\/td>\nUserParameters<\/a><\/td>\n<\/td>\n<\/tr>\n
LimitPriceType<\/td>\nInt_t<\/td>\nfalse<\/td>\nfalse<\/td>\nUserParameters<\/a><\/td>\ntt_net_sdk.tt_stop.LimitPriceType<\/a><\/td>\n<\/tr>\n
WithATickType<\/td>\nInt_t<\/td>\nfalse<\/td>\nfalse<\/td>\nUserParameters<\/a><\/td>\ntt_net_sdk.tt_stop.WithATickType<\/a><\/td>\n<\/tr>\n
WithATick<\/td>\nQty_t<\/td>\nfalse<\/td>\ntrue<\/td>\nUserParameters<\/a><\/td>\n<\/td>\n<\/tr>\n
STime<\/td>\nUTCTimestamp_t<\/td>\nfalse<\/td>\ntrue<\/td>\nUserParameters<\/a><\/td>\n<\/td>\n<\/tr>\n
ETime<\/td>\nUTCTimestamp_t<\/td>\nfalse<\/td>\ntrue<\/td>\nUserParameters<\/a><\/td>\n<\/td>\n<\/tr>\n
ETimeAct<\/td>\nInt_t<\/td>\nfalse<\/td>\nfalse<\/td>\nUserParameters<\/a><\/td>\ntt_net_sdk.tt_stop.ETimeAct<\/a><\/td>\n<\/tr>\n
NoImplies<\/td>\nBoolean_t<\/td>\nfalse<\/td>\nfalse<\/td>\nUserParameters<\/a><\/td>\n<\/td>\n<\/tr>\n
AutoResubExpiredGTD<\/td>\nBoolean_t<\/td>\nfalse<\/td>\nfalse<\/td>\nUserParameters<\/a><\/td>\n<\/td>\n<\/tr>\n
WaitingOption<\/td>\nInt_t<\/td>\ntrue<\/td>\nfalse<\/td>\nUserParameters<\/a><\/td>\ntt_net_sdk.tt_stop.WaitingOption<\/a><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/figure>\n
<\/a>Set the User Disconnect Action<\/h2>\n
When your application launches an ADL algo, TT monitors the connection from your application to the TT ecosystem. If TT detects that your application has disconnected, you can specify the action to be taken on your algo. This can be done by specifying a single action for all algos when you initialize the API as follows.<\/p>\n
You can also specify this behavior on a per algo basis by setting the UserDisconnectAction<\/a> property of the OrderProfile<\/a> instance.<\/p>\n
<\/a>Set the co-location facility<\/h2>\n
TT has a pool of Algo Servers in each major data center. You must specify in which data center that you want your algo to execute as follows.<\/p>\n
<\/a>Launch the algo<\/h2>\n
Once your OrderProfile<\/a> is ready, you can launch an algo by calling the SendOrder()<\/a> method of the AlgoTradeSubscription<\/a> instance. The following code snippet demonstrates the launching of the TT Stop algo.<\/p>\n
<\/a>Pause and resume ADL algos<\/h2>\n
ADL algos can be paused and then resumed. To accomplish this through the API, you simply set the OrderAction<\/a> to the appropriate value as follows.<\/p>\n","protected":false},"author":2,"template":"wp-custom-template-single-doc-tt-net-sdk","meta":{"_acf_changed":true,"footnotes":""},"docs-category":[780],"class_list":["post-8098","doc","type-doc","status-publish","hentry","docs-category-algo-server"],"acf":[],"_links":{"self":[{"href":"https:\/\/library-staging.tradingtechnologies.com\/ja\/wp-json\/wp\/v2\/doc\/8098","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/library-staging.tradingtechnologies.com\/ja\/wp-json\/wp\/v2\/doc"}],"about":[{"href":"https:\/\/library-staging.tradingtechnologies.com\/ja\/wp-json\/wp\/v2\/types\/doc"}],"author":[{"embeddable":true,"href":"https:\/\/library-staging.tradingtechnologies.com\/ja\/wp-json\/wp\/v2\/users\/2"}],"version-history":[{"count":0,"href":"https:\/\/library-staging.tradingtechnologies.com\/ja\/wp-json\/wp\/v2\/doc\/8098\/revisions"}],"wp:attachment":[{"href":"https:\/\/library-staging.tradingtechnologies.com\/ja\/wp-json\/wp\/v2\/media?parent=8098"}],"wp:term":[{"taxonomy":"docs-category","embeddable":true,"href":"https:\/\/library-staging.tradingtechnologies.com\/ja\/wp-json\/wp\/v2\/docs-category?post=8098"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}