{"id":7032,"date":"2025-08-28T22:12:00","date_gmt":"2025-08-29T03:12:00","guid":{"rendered":"https:\/\/librarytestdev.wpenginepowered.com\/?post_type=doc&#038;p=7032"},"modified":"2025-12-17T10:45:44","modified_gmt":"2025-12-17T16:45:44","slug":"deploying-an-algo-definition","status":"publish","type":"doc","link":"https:\/\/library-staging.tradingtechnologies.com\/apis\/tt-core-sdk\/creating-a-tt-application-server\/deploying-an-algo-definition\/","title":{"rendered":"Deploying An Algo Definition"},"content":{"rendered":"\n<p class=\"wp-block-paragraph\">Once you have created the metadata file for your algo, you must deploy it to make it visible in the TT user interface.  Deploying it is accomplished by executing the Python script named \u201cdeploy.py\u201d that is provided as part of the TT Core SDK.<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>\n$ python deploy.py -f &lt;metadata xml file&gt; -s &lt;appkey:secret&gt; -e &lt;environment&gt;\n<\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">where \u201c&lt;appkey:secret&gt;\u201d is an application key that you have created and \u201c&lt;environment&gt;\u201d is either \u201cext-uat-cert\u201d, \u201cext-prod-sim\u201d, or \u201cext-prod-live\u201d.  For example:<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>\n$ python deploy.py -f myalgo.xml -s \n00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000 -e ext-prod-live\n<\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">You can undeploy a previously deployed algo using the Python script named \u201cundeploy.py\u201d that is provided as part of the TT Core SDK as follows:<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>\n$ python undeploy.py -a &lt;algo id&gt; -s &lt;appkey:secret&gt; -e &lt;environment&gt;\n<\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">where \u201c&lt;appkey:secret&gt;\u201d is an application key that you have created and \u201c\n \n<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>\n$ python undeploy.py -a 14003993766928758006 -s \n00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000 -e ext-prod-live\n        <\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">You can share a previously deployed algo using the Python script named \u201cshare.py\u201d that is provided as part of the TT Core SDK as follows:<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>\n$ python share.py -a &lt;algo id&gt; -s &lt;appkey:secret&gt; -e &lt;environment&gt; -m &lt;email&gt;\n        <\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">where \u201c&lt;appkey:secret&gt;\u201d is an application key that you have created, \u201c&lt;email&gt;\u201d is the email address of the user with whom you want to share the algo and \u201c&lt;environment&gt;\u201d is either \u201cext-uat-cert\u201d, \u201cext-prod-sim\u201d, or \u201cext-prod-live\u201d.  For example:<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>\n$ python share.py -a 14003993766928758006 -s \n00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000 -e ext-prod-live \n-m bob.smith@mycompany.com\n            <\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">*** IMPORTANT:  All algos must be shared with the user who will be running the TT Application Server.  Furthermore, the user running the TT Application Server must have at least the same permissions as the user who launches an algo in terms of market data, etc.\n<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">You can unshare a previously deployed algo using the Python script named \u201cunshare.py\u201d that is provided as part of the TT Core SDK as follows:<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>\n$ python unshare.py -a &lt;algo id&gt;-e &lt;environment&gt; -m &lt;email&gt;\n        <\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">where \u201c&lt;appkey:secret&gt;\u201d is an application key that you have created, \u201c&lt;email&gt;\u201d is the email address of the user with whom you want to unshare the algo and \u201c&lt;environment&gt;\u201d is either \u201cext-uat-cert\u201d, \u201cext-prod-sim\u201d, or \u201cext-prod-live\u201d.  For example:<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>\n$ python unshare.py -a 14003993766928758006 -s \n00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000 -e ext-prod-live \n-m bob.smith@mycompany.com\n            <\/code><\/pre>\n","protected":false},"excerpt":{"rendered":"<p class=\"wp-block-paragraph\">Once you have created the metadata file for your algo, you must deploy it to make it visible in the TT user interface.  Deploying it is accomplished by executing the Python script named \u201cdeploy.py\u201d that is provided as part of the TT Core SDK.<\/p>\n<p class=\"wp-block-paragraph\">where \u201c&lt;appkey:secret&gt;\u201d is an application key that you have created and \u201c&lt;environment&gt;\u201d is either \u201cext-uat-cert\u201d, \u201cext-prod-sim\u201d, or \u201cext-prod-live\u201d.  For example:<\/p>\n<p class=\"wp-block-paragraph\">You can undeploy a previously deployed algo using the Python script named \u201cundeploy.py\u201d that is provided as part of the TT Core SDK as follows:<\/p>\n<p class=\"wp-block-paragraph\">where \u201c&lt;appkey:secret&gt;\u201d is an application key that you have created and \u201c<\/p>\n<p class=\"wp-block-paragraph\">You can share a previously deployed algo using the Python script named \u201cshare.py\u201d that is provided as part of the TT Core SDK as follows:<\/p>\n<p class=\"wp-block-paragraph\">where \u201c&lt;appkey:secret&gt;\u201d is an application key that you have created, \u201c&lt;email&gt;\u201d is the email address of the user with whom you want to share the algo and \u201c&lt;environment&gt;\u201d is either \u201cext-uat-cert\u201d, \u201cext-prod-sim\u201d, or \u201cext-prod-live\u201d.  For example:<\/p>\n<p class=\"wp-block-paragraph\">*** IMPORTANT:  All algos must be shared with the user who will be running the TT Application Server.  Furthermore, the user running the TT Application Server must have at least the same permissions as the user who launches an algo in terms of market data, etc.\n<\/p>\n<p class=\"wp-block-paragraph\">You can unshare a previously deployed algo using the Python script named \u201cunshare.py\u201d that is provided as part of the TT Core SDK as follows:<\/p>\n<p class=\"wp-block-paragraph\">where \u201c&lt;appkey:secret&gt;\u201d is an application key that you have created, \u201c&lt;email&gt;\u201d is the email address of the user with whom you want to unshare the algo and \u201c&lt;environment&gt;\u201d is either \u201cext-uat-cert\u201d, \u201cext-prod-sim\u201d, or \u201cext-prod-live\u201d.  For example:<\/p>\n","protected":false},"author":2,"template":"wp-custom-template-single-doc-tt-core-sdk","meta":{"_acf_changed":false,"footnotes":""},"docs-category":[1623],"class_list":["post-7032","doc","type-doc","status-publish","hentry","docs-category-creating-a-tt-application-server"],"acf":[],"_links":{"self":[{"href":"https:\/\/library-staging.tradingtechnologies.com\/ja\/wp-json\/wp\/v2\/doc\/7032","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\/7032\/revisions"}],"wp:attachment":[{"href":"https:\/\/library-staging.tradingtechnologies.com\/ja\/wp-json\/wp\/v2\/media?parent=7032"}],"wp:term":[{"taxonomy":"docs-category","embeddable":true,"href":"https:\/\/library-staging.tradingtechnologies.com\/ja\/wp-json\/wp\/v2\/docs-category?post=7032"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}