{"id":7917,"date":"2025-09-04T14:30:53","date_gmt":"2025-09-04T19:30:53","guid":{"rendered":"https:\/\/librarytestdev.wpenginepowered.com\/?post_type=doc&#038;p=7917"},"modified":"2025-09-04T15:33:15","modified_gmt":"2025-09-04T20:33:15","slug":"before-you-begin","status":"publish","type":"doc","link":"https:\/\/library-staging.tradingtechnologies.com\/apis\/tt-rest-api-2-0\/getting-started-tt-rest-api-2-0\/before-you-begin\/","title":{"rendered":"Before you begin"},"content":{"rendered":"\n<div class=\"wp-block-twentytwentyfive-child-tt-callout component-callout callout-danger\">\n<h3 class=\"wp-block-heading\" id=\"you-must-have-an-application-key-and-application-key-secret-to-u\">You must have an&nbsp;<strong>application key<\/strong>&nbsp;and&nbsp;<strong>application key secret<\/strong>&nbsp;to use the TT REST API<a href=\"\/tt-rest\/v2\/gs-before.html#you-must-have-an-application-key-and-application-key-secret-to-u\"><\/a><\/h3>\n\n\n\n<ul class=\"wp-block-list\">\n<li>All requests to the TT REST API require the inclusion of an\u00a0<strong>application key<\/strong>\u00a0in their header.<\/li>\n\n\n\n<li>In addition, a\u00a0<strong>token<\/strong>\u00a0is also required and is retrieved using the application key secret.<\/li>\n\n\n\n<li>The application key and the application key secret used to generate the token must be created in\u00a0<strong>Setup<\/strong>.<\/li>\n<\/ul>\n<\/div>\n\n\n\n<div class=\"wp-block-twentytwentyfive-child-tt-callout component-callout callout-success\">\n<p class=\"wp-block-paragraph\"><strong>Note<\/strong>: Creating TT REST API application keys requires company administrators to enable the&nbsp;<strong>Can create TT Rest API key<\/strong>&nbsp;setting for the user. For more information, refer to the&nbsp;<a href=\"\/user-setup\/af-apis.html\">Enabling API Key Creation<\/a>&nbsp;section in the Setup help.<\/p>\n<\/div>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"application-key-usage-plans-and-message-limits\">Application key usage plans and message limits<a href=\"\/tt-rest\/v2\/gs-before.html#application-key-usage-plans-and-message-limits\"><\/a><\/h2>\n\n\n\n<p class=\"wp-block-paragraph\" id=\"usage-plans\">Using the TT REST API requires you to select a usage plan for the application key that can incur additional costs. TT offers the following usage plans for TT REST application keys:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li><strong>Free<\/strong>: Allows you to develop and test TT REST applications in UAT only with limits of 3 requests per second and 10,000 requests per day<sup>*<\/sup><\/li>\n\n\n\n<li><strong>Low<\/strong>: Allows you to run TT REST applications in the Live environment with limits of 5 requests per second and 15,000 requests per day.<sup>*<\/sup><\/li>\n\n\n\n<li><strong>Medium<\/strong>: Allows you to run TT REST applications in the Live environment with limits of 10 requests per second and 30,000 requests per day.<sup>*<\/sup><\/li>\n\n\n\n<li><strong>High<\/strong>: Allows you to run TT REST applications in the Live environment with limits of 25 requests per second and 75,000 requests per day.<sup>*<\/sup><\/li>\n<\/ul>\n\n\n\n<p class=\"wp-block-paragraph\">For more information about the costs associated with the usage plans, contact TT Customer Success.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\"><strong><sup>*<\/sup>&nbsp;Note<\/strong>: You can manage users, accounts, permissions and risk through the various endpoints in the TT REST API. Due to the amount of data that can be sent in POST endpoints, the TT REST API limits their frequency to one POST request every ten seconds. Most daily maintenance and activity will not be affected by these limits and can be accomplished normally on week days.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"appkey\">Getting an Application Key and Application Secret<a href=\"\/tt-rest\/v2\/gs-before.html#appkey\"><\/a><\/h2>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"appkey-prerequisite\">Prerequisite<a href=\"\/tt-rest\/v2\/gs-before.html#appkey-prerequisite\"><\/a><\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">Prior to creating your own application key, your company&#8217;s administrator must enable the&nbsp;<strong>Can create TT Rest API key<\/strong>&nbsp;setting for the user. For more information, refer to the&nbsp;<a href=\"\/user-setup\/af-apis.html\">Enabling API Key Creation<\/a>&nbsp;section in the Setup help.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"creating-a-key\">Creating an Application Key<a href=\"\/tt-rest\/v2\/gs-before.html#creating-a-key\"><\/a><\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">To create an application key:<\/p>\n\n\n\n<ol class=\"wp-block-list\">\n<li>Verify that your administrator has enabled the\u00a0<strong>Can create TT Rest API key<\/strong>\u00a0setting for your user in the Setup application.<\/li>\n\n\n\n<li>Log into\u00a0<strong>Setup<\/strong>\u00a0in the TT Platform:\n<ul class=\"wp-block-list\">\n<li>Log into the UAT environment (<strong>ext_uat_cert<\/strong>) to create app keys for development.<\/li>\n\n\n\n<li>Log into the Live environment (<strong>ext_prod_live<\/strong>) to create app keys for accessing live data.<\/li>\n<\/ul>\n<\/li>\n\n\n\n<li>Click\u00a0<strong>Users<\/strong>\u00a0in the left navigation panel and select your username in the data grid.<\/li>\n\n\n\n<li>Click the\u00a0<strong>App Keys<\/strong>\u00a0tab.<\/li>\n\n\n\n<li>In the title bar of the\u00a0<strong>App Keys<\/strong>\u00a0data grid, click\u00a0<strong>New<\/strong>.<img decoding=\"async\" src=\"https:\/\/library-staging.tradingtechnologies.com\/wp-content\/uploads\/2025\/09\/ttus-app-key-create-1-2-scaled.png\"><\/li>\n\n\n\n<li>Enter a user-defined name in the\u00a0<strong>Application Key Name<\/strong>\u00a0field.<\/li>\n\n\n\n<li>In the\u00a0<strong>Application Key Type<\/strong>\u00a0drop-down, select\u00a0<strong>TT REST API<\/strong>.<\/li>\n\n\n\n<li>Select the desired\u00a0<a href=\"\/tt-rest\/v2\/gs-before.html#usage-plans\">usage plan<\/a>\u00a0in the\u00a0<strong>Application Key Usage Plan<\/strong>\u00a0drop-down.<img decoding=\"async\" src=\"https:\/\/library-staging.tradingtechnologies.com\/wp-content\/uploads\/2025\/09\/ttus-app-key-create-2a-2.png\" alt=\"\"><strong>Note<\/strong>: In the UAT testing environment, only the free plan is available. In the Live environment, only the Low, Medium and High plans are available.<\/li>\n\n\n\n<li>Click\u00a0<strong>Create to generate the application key<\/strong>.<\/li>\n\n\n\n<li>The\u00a0<strong>application key secret<\/strong>\u00a0is displayed in the\u00a0<strong>Secret<\/strong>\u00a0field. Click\u00a0<strong>Copy Secret to Clipboard<\/strong>\u00a0and then paste this application secret somewhere on your machine.<strong>Warning<\/strong>: This is the only time you will be able to copy your new key&#8217;s secret.<\/li>\n\n\n\n<li>To get the\u00a0<strong>application key<\/strong>, exit the\u00a0<strong>Create New Application Key<\/strong>\u00a0screen by clicking\u00a0<strong>Ok<\/strong>.<\/li>\n\n\n\n<li>Your\u00a0<strong>application key<\/strong>\u00a0is displayed in the\u00a0<strong>Value<\/strong>\u00a0column. Record it for use with your the application secret from earlier.<\/li>\n<\/ol>\n","protected":false},"excerpt":{"rendered":"<p>Application key usage plans and message limits Using the TT REST API requires you to select a usage plan for t [&hellip;]<\/p>\n","protected":false},"author":2,"template":"","meta":{"_acf_changed":true,"footnotes":""},"docs-category":[733],"class_list":["post-7917","doc","type-doc","status-publish","hentry","docs-category-getting-started-tt-rest-api-2-0"],"acf":[],"_links":{"self":[{"href":"https:\/\/library-staging.tradingtechnologies.com\/ja\/wp-json\/wp\/v2\/doc\/7917","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\/7917\/revisions"}],"wp:attachment":[{"href":"https:\/\/library-staging.tradingtechnologies.com\/ja\/wp-json\/wp\/v2\/media?parent=7917"}],"wp:term":[{"taxonomy":"docs-category","embeddable":true,"href":"https:\/\/library-staging.tradingtechnologies.com\/ja\/wp-json\/wp\/v2\/docs-category?post=7917"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}