{"id":7955,"date":"2025-09-04T16:34:01","date_gmt":"2025-09-04T21:34:01","guid":{"rendered":"https:\/\/librarytestdev.wpenginepowered.com\/?post_type=doc&#038;p=7955"},"modified":"2026-01-05T13:18:42","modified_gmt":"2026-01-05T19:18:42","slug":"ttid-documentation-2","status":"publish","type":"doc","link":"https:\/\/library-staging.tradingtechnologies.com\/apis\/tt-rest-api-2-0-uat\/api-reference-tt-rest-api-2-0-uat\/ttid-documentation-2\/","title":{"rendered":"ttid Documentation"},"content":{"rendered":"\n<p class=\"wp-block-paragraph\">The ttid service of the TT REST API is used to assist in creating users.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Requests to the ttid service of the TT REST API use the following base URL:&nbsp;<strong>ttrestapi.trade.tt\/ttid\/&lt;environment&gt;<\/strong>:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>https:\/\/ttrestapi.trade.tt\/ttid\/ext_uat_cert for application development and testing<\/li>\n\n\n\n<li>https:\/\/ttrestapi.trade.tt\/ttid\/ext_prod_live for deploying an application to production<\/li>\n<\/ul>\n\n\n\n<p class=\"wp-block-paragraph\"><strong>Note<\/strong>: When submitting requests, all API urls are case sensitive and should include the endpoint name in lowercase. For example, using&nbsp;<em>https:\/\/ttrestapi.trade.tt\/<strong>TTID<\/strong>\/ext_uat_cert\/<\/em>&nbsp;results in a 403 server error.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">You must use&nbsp;<em>https:\/\/ttrestapi.trade.tt\/<strong>ttid<\/strong>\/ext_uat_cert\/<\/em>&nbsp;in order to properly reach the API.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"access-parameters\">Access Parameters<a href=\"\/tt-rest\/v2_uat\/ttid.html#access-parameters\"><\/a><\/h2>\n\n\n\n<p class=\"wp-block-paragraph\">Calls to the ttid service listed below require both of the following in your header:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li><strong>Application Key<\/strong>\n<ul class=\"wp-block-list\">\n<li><code>x-api-key=&lt;application key&gt;<\/code><\/li>\n<\/ul>\n<\/li>\n\n\n\n<li><strong>Token<\/strong>\n<ul class=\"wp-block-list\">\n<li><code>Authorization=Bearer &lt;token&gt;<\/code><\/li>\n<\/ul>\n<\/li>\n<\/ul>\n\n\n\n<p class=\"wp-block-paragraph\">For instructions on obtaining your\u00a0<a href=\"\/tt-rest\/v2_uat\/gs-before.html\">application key<\/a>\u00a0and\u00a0<a href=\"\/tt-rest\/v2_uat\/gs-token.html\">token<\/a>, refer to the\u00a0<a href=\"\/tt-rest\/v2_uat\/gs-before.html\">Before you begin<\/a>\u00a0and\u00a0<a href=\"\/tt-rest\/v2_uat\/gs-token.html\">Authentication and request IDs<\/a>\u00a0articles in the TT REST API documentation.<\/p>\n\n\n<div data-post-id=\"28989\" class=\"insert-page insert-page-28989 \">\n<h2 class=\"wp-block-heading\" id=\"test-calls\">Test calls<a href=\"\/tt-rest\/v2\/ttmonitor.html#test-calls\"><\/a><\/h2>\n\n\n\n<p class=\"wp-block-paragraph\">To test the calls below, click the\u00a0<strong>Authorize<\/strong>\u00a0button and enter values for both access parameters into the &#8220;Available authorizations&#8221; dialog.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\"><strong>Note:<\/strong>\u00a0When entering your\u00a0<strong>token<\/strong>,\u00a0you will need to manually concatenate &#8220;Bearer&#8221; and a single space in front of the token value sent by ttid.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">All test calls sent through this help site use the following base URL:<\/p>\n\n\n\n<p class=\"wp-block-paragraph\"><code>https:\/\/ttrestapi.trade.tt\/ttmonitor\/ext_uat_cert<\/code><\/p>\n\n\n\n<p class=\"wp-block-paragraph\"><\/p>\n<\/div>\n\n<div id=\"swagger-ui-1e2d3792-28da-49e6-a960-e407814f4eb1\" class=\"swagger-ui-container-manual hide-options hide-topbar hide-info hide-server hide-default-tag\" data-swagger-config=\"{&quot;spec&quot;:{&quot;openapi&quot;:&quot;3.0.1&quot;,&quot;info&quot;:{&quot;title&quot;:&quot;ttid&quot;,&quot;version&quot;:&quot;2018-10-11T15:26:08Z&quot;},&quot;servers&quot;:[{&quot;url&quot;:&quot;https:\\\/\\\/ttrestapi.trade.tt\\\/{basePath}&quot;,&quot;variables&quot;:{&quot;basePath&quot;:{&quot;default&quot;:&quot;ttid\\\/ext_uat_cert\\\/&quot;}}}],&quot;paths&quot;:{&quot;\\\/token&quot;:{&quot;post&quot;:{&quot;parameters&quot;:[{&quot;name&quot;:&quot;Content-Type&quot;,&quot;in&quot;:&quot;header&quot;,&quot;schema&quot;:{&quot;type&quot;:&quot;string&quot;},&quot;description&quot;:&quot;Must be set to &#039;application\\\/x-www-form-urlencoded&#039;.&quot;},{&quot;name&quot;:&quot;x-api-key&quot;,&quot;in&quot;:&quot;header&quot;,&quot;required&quot;:true,&quot;schema&quot;:{&quot;type&quot;:&quot;string&quot;},&quot;description&quot;:&quot;Set to your application key. This hexadecimal value appears in the format: &lt;b&gt;00000000-0000-0000-0000-000000000000&lt;\\\/b&gt;.&quot;},{&quot;name&quot;:&quot;requestId&quot;,&quot;in&quot;:&quot;query&quot;,&quot;required&quot;:&quot;true&quot;,&quot;schema&quot;:{&quot;type&quot;:&quot;string&quot;},&quot;example&quot;:&quot;myApp-myCompany--4037847b-de40-46c8-b55e-66186d657614&quot;,&quot;description&quot;:&quot;Unique ID for this request. TT strongly recommends ensuring that you match the correct format for this value. For more information, refer to [Providing a Request ID](gs-token.html#requestId). You must include the &lt;code&gt;requestId&lt;\\\/code&gt; query parameter for all requests.&lt;br\\\/&gt; The TT REST API documentation pre-populates a sample &lt;code&gt;requestId&lt;\\\/code&gt; which can only be used when making test calls.&quot;}],&quot;responses&quot;:{&quot;200&quot;:{&quot;content&quot;:{&quot;application\\\/json&quot;:{&quot;schema&quot;:{&quot;$ref&quot;:&quot;&quot;}}}}},&quot;security&quot;:[{&quot;api_key&quot;:[],&quot;Token&quot;:[]}],&quot;x-amazon-apigateway-integration&quot;:{&quot;httpMethod&quot;:&quot;POST&quot;,&quot;uri&quot;:&quot;https:\\\/\\\/${stageVariables.environment}\\\/oauth\\\/token?grant_type=user_app&quot;,&quot;responses&quot;:{&quot;4\\\\d{2}&quot;:{&quot;statusCode&quot;:&quot;400&quot;,&quot;responseParameters&quot;:{&quot;method.response.header.Access-Control-Allow-Origin&quot;:&quot;&#039;*&#039;&quot;,&quot;method.response.header.Strict-Transport-Security&quot;:&quot;&#039;max-age=31536000&#039;&quot;,&quot;method.response.header.Content-Security-Policy&quot;:&quot;&#039;frame-ancestors &#039;none&#039;&#039;&quot;,&quot;method.response.header.X-Content-Type-Options&quot;:&quot;&#039;nosniff&#039;&quot;,&quot;method.response.header.X-Frame-Options&quot;:&quot;&#039;deny&#039;&quot;,&quot;method.response.header.Referrer-Policy&quot;:&quot;&#039;same-origin&#039;&quot;},&quot;responseTemplates&quot;:{&quot;application\\\/json&quot;:&quot;#set($inputRoot = $input.path(&#039;$&#039;))\\n{\\n  \\&quot;status\\&quot; : \\&quot;StatusFail\\&quot;,\\n  \\&quot;status_message\\&quot; : \\&quot;$inputRoot.error\\&quot;,\\n  \\&quot;status_desc\\&quot; : \\&quot;$inputRoot.error_description\\&quot;,\\n    \\&quot;statusCode\\&quot;:400\\n}&quot;}},&quot;default&quot;:{&quot;statusCode&quot;:&quot;200&quot;,&quot;responseParameters&quot;:{&quot;method.response.header.Access-Control-Allow-Origin&quot;:&quot;&#039;*&#039;&quot;,&quot;method.response.header.Strict-Transport-Security&quot;:&quot;&#039;max-age=31536000&#039;&quot;,&quot;method.response.header.Content-Security-Policy&quot;:&quot;&#039;frame-ancestors &#039;none&#039;&#039;&quot;,&quot;method.response.header.X-Content-Type-Options&quot;:&quot;&#039;nosniff&#039;&quot;,&quot;method.response.header.X-Frame-Options&quot;:&quot;&#039;deny&#039;&quot;,&quot;method.response.header.Referrer-Policy&quot;:&quot;&#039;same-origin&#039;&quot;},&quot;responseTemplates&quot;:{&quot;application\\\/json&quot;:&quot;#set($inputRoot = $input.path(&#039;$&#039;))\\n{\\n    #if ($inputRoot.error != \\&quot;\\&quot;)\\n    \\&quot;status\\&quot; : \\&quot;Fail\\&quot;,\\n    \\&quot;status_message\\&quot; : \\&quot;$inputRoot.error_description\\&quot;\\n    #else\\n  \\n      #if ($inputRoot.access_token != \\&quot;\\&quot;)\\n      \\&quot;status\\&quot; : \\&quot;Ok\\&quot;,\\n      \\&quot;access_token\\&quot;: \\&quot;$inputRoot.access_token\\&quot;,\\n      \\&quot;token_type\\&quot;: \\&quot;$inputRoot.token_type\\&quot;,\\n      \\&quot;seconds_until_expiry\\&quot;: $inputRoot.expires_in\\n      #end\\n  \\n    #end\\n}&quot;}},&quot;5\\\\d{2}&quot;:{&quot;statusCode&quot;:&quot;500&quot;,&quot;responseParameters&quot;:{&quot;method.response.header.Access-Control-Allow-Origin&quot;:&quot;&#039;*&#039;&quot;,&quot;method.response.header.Strict-Transport-Security&quot;:&quot;&#039;max-age=31536000&#039;&quot;,&quot;method.response.header.Content-Security-Policy&quot;:&quot;&#039;frame-ancestors &#039;none&#039;&#039;&quot;,&quot;method.response.header.X-Content-Type-Options&quot;:&quot;&#039;nosniff&#039;&quot;,&quot;method.response.header.X-Frame-Options&quot;:&quot;&#039;deny&#039;&quot;,&quot;method.response.header.Referrer-Policy&quot;:&quot;&#039;same-origin&#039;&quot;},&quot;responseTemplates&quot;:{&quot;application\\\/json&quot;:&quot;#set($inputRoot = $input.path(&#039;$&#039;))\\n{\\n  \\&quot;status\\&quot; : \\&quot;StatusFail\\&quot;,\\n  \\&quot;status_message\\&quot; : \\&quot;$inputRoot.error\\&quot;,\\n  \\&quot;status_desc\\&quot; : \\&quot;$inputRoot.error_description\\&quot;,\\n    \\&quot;statusCode\\&quot;:500\\n}&quot;}}},&quot;requestParameters&quot;:{&quot;integration.request.header.x-api-key&quot;:&quot;method.request.header.x-api-key&quot;,&quot;integration.request.header.Content-Type&quot;:&quot;method.request.header.Content-Type&quot;,&quot;integration.request.querystring.request_id&quot;:&quot;method.request.querystring.requestId&quot;},&quot;passthroughBehavior&quot;:&quot;when_no_match&quot;,&quot;type&quot;:&quot;http&quot;},&quot;application\\\/json&quot;:{&quot;schema&quot;:{&quot;$ref&quot;:&quot;&quot;}},&quot;description&quot;:&quot;To get a token, you send your application key and application secret within a POST request to generate a token.&quot;,&quot;summary&quot;:&quot;Gets a token given an application key.&quot;},&quot;options&quot;:{&quot;responses&quot;:{&quot;200&quot;:{&quot;description&quot;:&quot;200 response&quot;,&quot;headers&quot;:{&quot;Access-Control-Allow-Origin&quot;:{&quot;schema&quot;:{&quot;type&quot;:&quot;string&quot;}},&quot;Access-Control-Allow-Methods&quot;:{&quot;schema&quot;:{&quot;type&quot;:&quot;string&quot;}},&quot;Access-Control-Allow-Headers&quot;:{&quot;schema&quot;:{&quot;type&quot;:&quot;string&quot;}},&quot;Strict-Transport-Security&quot;:{&quot;schema&quot;:{&quot;type&quot;:&quot;string&quot;}},&quot;Content-Security-Policy&quot;:{&quot;schema&quot;:{&quot;type&quot;:&quot;string&quot;}},&quot;X-Content-Type-Options&quot;:{&quot;schema&quot;:{&quot;type&quot;:&quot;string&quot;}},&quot;X-Frame-Options&quot;:{&quot;schema&quot;:{&quot;type&quot;:&quot;string&quot;}},&quot;Referrer-Policy&quot;:{&quot;schema&quot;:{&quot;type&quot;:&quot;string&quot;}}},&quot;content&quot;:{}}},&quot;x-amazon-apigateway-integration&quot;:{&quot;responses&quot;:{&quot;default&quot;:{&quot;statusCode&quot;:&quot;200&quot;,&quot;responseParameters&quot;:{&quot;method.response.header.Access-Control-Allow-Methods&quot;:&quot;&#039;POST,OPTIONS&#039;&quot;,&quot;method.response.header.Access-Control-Allow-Headers&quot;:&quot;&#039;Content-Type,X-Amz-Date,Authorization,X-Api-Key,X-Amz-Security-Token&#039;&quot;,&quot;method.response.header.Access-Control-Allow-Origin&quot;:&quot;&#039;*&#039;&quot;,&quot;method.response.header.Strict-Transport-Security&quot;:&quot;&#039;max-age=31536000&#039;&quot;,&quot;method.response.header.Content-Security-Policy&quot;:&quot;&#039;frame-ancestors &#039;none&#039;&#039;&quot;,&quot;method.response.header.X-Content-Type-Options&quot;:&quot;&#039;nosniff&#039;&quot;,&quot;method.response.header.X-Frame-Options&quot;:&quot;&#039;deny&#039;&quot;,&quot;method.response.header.Referrer-Policy&quot;:&quot;&#039;same-origin&#039;&quot;}}},&quot;requestTemplates&quot;:{&quot;application\\\/json&quot;:&quot;{\\&quot;statusCode\\&quot;: 200}&quot;},&quot;passthroughBehavior&quot;:&quot;when_no_match&quot;,&quot;type&quot;:&quot;mock&quot;}}},&quot;\\\/keyusage&quot;:{&quot;get&quot;:{&quot;parameters&quot;:[{&quot;name&quot;:&quot;appKey&quot;,&quot;in&quot;:&quot;query&quot;,&quot;required&quot;:true,&quot;schema&quot;:{&quot;type&quot;:&quot;string&quot;},&quot;description&quot;:&quot;The application key for which you would like usage data.&quot;},{&quot;name&quot;:&quot;userId&quot;,&quot;in&quot;:&quot;query&quot;,&quot;required&quot;:true,&quot;schema&quot;:{&quot;type&quot;:&quot;string&quot;},&quot;description&quot;:&quot;User ID. Can be retrieved by the &lt;code&gt;\\\/users&lt;\\\/code&gt; GET request.&quot;},{&quot;name&quot;:&quot;startDate&quot;,&quot;in&quot;:&quot;query&quot;,&quot;required&quot;:true,&quot;schema&quot;:{&quot;type&quot;:&quot;string&quot;},&quot;description&quot;:&quot;The beginning of the time period (in UTC) for which you would like to see the number of requests made against the usage plan quota beginning at Midnight UTC of the provided date. Requires YYYY-MM-DD format.&quot;},{&quot;name&quot;:&quot;endDate&quot;,&quot;in&quot;:&quot;query&quot;,&quot;required&quot;:true,&quot;schema&quot;:{&quot;type&quot;:&quot;string&quot;},&quot;description&quot;:&quot;The end of the time period (in UTC) for which you would like to see the number of requests made against the usage plan quota beginning at Midnight UTC of the provided date. Requires YYYY-MM-DD format. If today&#039;s date is provided, usage for the day so far will be returned.&quot;},{&quot;name&quot;:&quot;requestId&quot;,&quot;in&quot;:&quot;query&quot;,&quot;required&quot;:&quot;true&quot;,&quot;schema&quot;:{&quot;type&quot;:&quot;string&quot;},&quot;example&quot;:&quot;myApp-myCompany--4037847b-de40-46c8-b55e-66186d657614&quot;,&quot;description&quot;:&quot;Unique ID for this request. TT strongly recommends ensuring that you match the correct format for this value. For more information, refer to [Providing a Request ID](gs-token.html#requestId). You must include the &lt;code&gt;requestId&lt;\\\/code&gt; query parameter for all requests.&lt;br\\\/&gt; The TT REST API documentation pre-populates a sample &lt;code&gt;requestId&lt;\\\/code&gt; which can only be used when making test calls.&quot;}],&quot;responses&quot;:{&quot;200&quot;:{&quot;content&quot;:{&quot;application\\\/json&quot;:{&quot;schema&quot;:{&quot;$ref&quot;:&quot;&quot;}}}}},&quot;security&quot;:[{&quot;api_key&quot;:[],&quot;Token&quot;:[]}],&quot;x-amazon-apigateway-integration&quot;:{&quot;type&quot;:&quot;aws&quot;,&quot;uri&quot;:{&quot;Fn::Sub&quot;:&quot;arn:aws:apigateway:${AWS::Region}:lambda:path\\\/2015-03-31\\\/functions\\\/${ttidkeyusage}\\\/invocations&quot;},&quot;responses&quot;:{&quot;.*.400.*&quot;:{&quot;statusCode&quot;:&quot;400&quot;,&quot;responseParameters&quot;:{&quot;method.response.header.Access-Control-Allow-Origin&quot;:&quot;&#039;*&#039;&quot;,&quot;method.response.header.Strict-Transport-Security&quot;:&quot;&#039;max-age=31536000&#039;&quot;,&quot;method.response.header.Content-Security-Policy&quot;:&quot;&#039;frame-ancestors &#039;none&#039;&#039;&quot;,&quot;method.response.header.X-Content-Type-Options&quot;:&quot;&#039;nosniff&#039;&quot;,&quot;method.response.header.X-Frame-Options&quot;:&quot;&#039;deny&#039;&quot;,&quot;method.response.header.Referrer-Policy&quot;:&quot;&#039;same-origin&#039;&quot;},&quot;responseTemplates&quot;:{&quot;application\\\/json&quot;:&quot;#set ($errorMessageObj = $util.parseJson($input.path(&#039;$.errorMessage&#039;))){\\n    \\&quot;status\\&quot; : \\&quot;$errorMessageObj.status\\&quot;,\\n    \\&quot;status_message\\&quot; : \\&quot;$errorMessageObj.status_message\\&quot;,\\n    \\&quot;statusCode\\&quot;:400\\n}\\n&quot;}},&quot;default&quot;:{&quot;statusCode&quot;:&quot;200&quot;,&quot;responseParameters&quot;:{&quot;method.response.header.Access-Control-Allow-Origin&quot;:&quot;&#039;*&#039;&quot;,&quot;method.response.header.Strict-Transport-Security&quot;:&quot;&#039;max-age=31536000&#039;&quot;,&quot;method.response.header.Content-Security-Policy&quot;:&quot;&#039;frame-ancestors &#039;none&#039;&#039;&quot;,&quot;method.response.header.X-Content-Type-Options&quot;:&quot;&#039;nosniff&#039;&quot;,&quot;method.response.header.X-Frame-Options&quot;:&quot;&#039;deny&#039;&quot;,&quot;method.response.header.Referrer-Policy&quot;:&quot;&#039;same-origin&#039;&quot;}},&quot;.*.500.*&quot;:{&quot;statusCode&quot;:&quot;500&quot;,&quot;responseParameters&quot;:{&quot;method.response.header.Access-Control-Allow-Origin&quot;:&quot;&#039;*&#039;&quot;,&quot;method.response.header.Strict-Transport-Security&quot;:&quot;&#039;max-age=31536000&#039;&quot;,&quot;method.response.header.Content-Security-Policy&quot;:&quot;&#039;frame-ancestors &#039;none&#039;&#039;&quot;,&quot;method.response.header.X-Content-Type-Options&quot;:&quot;&#039;nosniff&#039;&quot;,&quot;method.response.header.X-Frame-Options&quot;:&quot;&#039;deny&#039;&quot;,&quot;method.response.header.Referrer-Policy&quot;:&quot;&#039;same-origin&#039;&quot;},&quot;responseTemplates&quot;:{&quot;application\\\/json&quot;:&quot;#set ($errorMessageObj = $util.parseJson($input.path(&#039;$.errorMessage&#039;))){\\n    \\&quot;status\\&quot; : \\&quot;$errorMessageObj.status\\&quot;,\\n    \\&quot;status_message\\&quot; : \\&quot;$errorMessageObj.status_message\\&quot;,\\n    \\&quot;statusCode\\&quot;:500\\n}\\n&quot;}}},&quot;requestTemplates&quot;:{&quot;application\\\/json&quot;:&quot;#set($inputJson = $input.json(&#039;$&#039;))\\n#set($environment = $input.path(&#039;$.environment&#039;))\\n{\\n\\&quot;query\\&quot;: {\\n    #foreach($queryParam in $input.params().querystring.keySet())\\n    \\&quot;$queryParam\\&quot;: \\&quot;$util.escapeJavaScript($input.params().querystring.get($queryParam))\\&quot; #if($foreach.hasNext),#end\\n    #end},\\n\\&quot;headers\\&quot;: {\\n        #foreach($param in $input.params().header.keySet())\\n            \\&quot;$param\\&quot;: \\&quot;$util.escapeJavaScript($input.params().header.get($param))\\&quot;\\n        #if($foreach.hasNext),#end\\n        #end\\n    }\\n}&quot;},&quot;passthroughBehavior&quot;:&quot;when_no_templates&quot;,&quot;httpMethod&quot;:&quot;POST&quot;,&quot;contentHandling&quot;:&quot;CONVERT_TO_TEXT&quot;},&quot;description&quot;:&quot;Gets the number of calls counted against the quota as well as your remaining quota defined in your usage plan. This endpoint returns an array of daily values.\\n\\n In order to request usage for keys that are not assoaciated with your login, the key used to authenticate this request must have administrative permissions.\\n\\n\\n**Note** Usage data may take up to 30 minutes to become available through this endpoint.&quot;,&quot;summary&quot;:&quot;Gets the number of calls counted against the quota as defined in your usage plan.&quot;},&quot;options&quot;:{&quot;responses&quot;:{&quot;200&quot;:{&quot;description&quot;:&quot;200 response&quot;,&quot;headers&quot;:{&quot;Access-Control-Allow-Origin&quot;:{&quot;schema&quot;:{&quot;type&quot;:&quot;string&quot;}},&quot;Access-Control-Allow-Methods&quot;:{&quot;schema&quot;:{&quot;type&quot;:&quot;string&quot;}},&quot;Access-Control-Allow-Headers&quot;:{&quot;schema&quot;:{&quot;type&quot;:&quot;string&quot;}},&quot;Strict-Transport-Security&quot;:{&quot;schema&quot;:{&quot;type&quot;:&quot;string&quot;}},&quot;Content-Security-Policy&quot;:{&quot;schema&quot;:{&quot;type&quot;:&quot;string&quot;}},&quot;X-Content-Type-Options&quot;:{&quot;schema&quot;:{&quot;type&quot;:&quot;string&quot;}},&quot;X-Frame-Options&quot;:{&quot;schema&quot;:{&quot;type&quot;:&quot;string&quot;}},&quot;Referrer-Policy&quot;:{&quot;schema&quot;:{&quot;type&quot;:&quot;string&quot;}}},&quot;content&quot;:{}}},&quot;x-amazon-apigateway-integration&quot;:{&quot;responses&quot;:{&quot;default&quot;:{&quot;statusCode&quot;:&quot;200&quot;,&quot;responseParameters&quot;:{&quot;method.response.header.Access-Control-Allow-Methods&quot;:&quot;&#039;DELETE,GET,HEAD,OPTIONS,PATCH,POST,PUT&#039;&quot;,&quot;method.response.header.Access-Control-Allow-Headers&quot;:&quot;&#039;Content-Type,Authorization,X-Amz-Date,X-Api-Key,X-Amz-Security-Token&#039;&quot;,&quot;method.response.header.Access-Control-Allow-Origin&quot;:&quot;&#039;*&#039;&quot;,&quot;method.response.header.Strict-Transport-Security&quot;:&quot;&#039;max-age=31536000&#039;&quot;,&quot;method.response.header.Content-Security-Policy&quot;:&quot;&#039;frame-ancestors &#039;none&#039;&#039;&quot;,&quot;method.response.header.X-Content-Type-Options&quot;:&quot;&#039;nosniff&#039;&quot;,&quot;method.response.header.X-Frame-Options&quot;:&quot;&#039;deny&#039;&quot;,&quot;method.response.header.Referrer-Policy&quot;:&quot;&#039;same-origin&#039;&quot;}}},&quot;requestTemplates&quot;:{&quot;application\\\/json&quot;:&quot;{\\&quot;statusCode\\&quot;: 200}&quot;},&quot;passthroughBehavior&quot;:&quot;when_no_match&quot;,&quot;type&quot;:&quot;mock&quot;}}},&quot;\\\/healthcheckstatus&quot;:{&quot;get&quot;:{&quot;parameters&quot;:[{&quot;name&quot;:&quot;requestId&quot;,&quot;in&quot;:&quot;query&quot;,&quot;required&quot;:&quot;true&quot;,&quot;schema&quot;:{&quot;type&quot;:&quot;string&quot;},&quot;example&quot;:&quot;myApp-myCompany--4037847b-de40-46c8-b55e-66186d657614&quot;,&quot;description&quot;:&quot;Unique ID for this request. TT strongly recommends ensuring that you match the correct format for this value. For more information, refer to [Providing a Request ID](gs-token.html#requestId). You must include the &lt;code&gt;requestId&lt;\\\/code&gt; query parameter for all requests.&lt;br\\\/&gt; The TT REST API documentation pre-populates a sample &lt;code&gt;requestId&lt;\\\/code&gt; which can only be used when making test calls.&quot;},{&quot;name&quot;:&quot;requestId&quot;,&quot;in&quot;:&quot;query&quot;,&quot;required&quot;:&quot;true&quot;,&quot;schema&quot;:{&quot;type&quot;:&quot;string&quot;},&quot;example&quot;:&quot;myApp-myCompany--4037847b-de40-46c8-b55e-66186d657614&quot;,&quot;description&quot;:&quot;Unique ID for this request. TT strongly recommends ensuring that you match the correct format for this value. For more information, refer to [Providing a Request ID](gs-token.html#requestId). You must include the &lt;code&gt;requestId&lt;\\\/code&gt; query parameter for all requests.&lt;br\\\/&gt; The TT REST API documentation pre-populates a sample &lt;code&gt;requestId&lt;\\\/code&gt; which can only be used when making test calls.&quot;}],&quot;responses&quot;:{&quot;400&quot;:{&quot;description&quot;:&quot;400 response&quot;,&quot;headers&quot;:{&quot;Strict-Transport-Security&quot;:{&quot;schema&quot;:{&quot;type&quot;:&quot;string&quot;}},&quot;Access-Control-Allow-Origin&quot;:{&quot;schema&quot;:{&quot;type&quot;:&quot;string&quot;}},&quot;Content-Security-Policy&quot;:{&quot;schema&quot;:{&quot;type&quot;:&quot;string&quot;}},&quot;X-Content-Type-Options&quot;:{&quot;schema&quot;:{&quot;type&quot;:&quot;string&quot;}},&quot;X-Frame-Options&quot;:{&quot;schema&quot;:{&quot;type&quot;:&quot;string&quot;}},&quot;Referrer-Policy&quot;:{&quot;schema&quot;:{&quot;type&quot;:&quot;string&quot;}}},&quot;content&quot;:{}},&quot;500&quot;:{&quot;description&quot;:&quot;500 response&quot;,&quot;headers&quot;:{&quot;Strict-Transport-Security&quot;:{&quot;schema&quot;:{&quot;type&quot;:&quot;string&quot;}},&quot;Access-Control-Allow-Origin&quot;:{&quot;schema&quot;:{&quot;type&quot;:&quot;string&quot;}},&quot;Content-Security-Policy&quot;:{&quot;schema&quot;:{&quot;type&quot;:&quot;string&quot;}},&quot;X-Content-Type-Options&quot;:{&quot;schema&quot;:{&quot;type&quot;:&quot;string&quot;}},&quot;X-Frame-Options&quot;:{&quot;schema&quot;:{&quot;type&quot;:&quot;string&quot;}},&quot;Referrer-Policy&quot;:{&quot;schema&quot;:{&quot;type&quot;:&quot;string&quot;}}},&quot;content&quot;:{}},&quot;200&quot;:{&quot;description&quot;:&quot;200 response&quot;,&quot;headers&quot;:{&quot;Strict-Transport-Security&quot;:{&quot;schema&quot;:{&quot;type&quot;:&quot;string&quot;}},&quot;Access-Control-Allow-Origin&quot;:{&quot;schema&quot;:{&quot;type&quot;:&quot;string&quot;}},&quot;Content-Security-Policy&quot;:{&quot;schema&quot;:{&quot;type&quot;:&quot;string&quot;}},&quot;X-Content-Type-Options&quot;:{&quot;schema&quot;:{&quot;type&quot;:&quot;string&quot;}},&quot;X-Frame-Options&quot;:{&quot;schema&quot;:{&quot;type&quot;:&quot;string&quot;}},&quot;Referrer-Policy&quot;:{&quot;schema&quot;:{&quot;type&quot;:&quot;string&quot;}}},&quot;content&quot;:{&quot;application\\\/json&quot;:{&quot;schema&quot;:{&quot;$ref&quot;:&quot;#\\\/components\\\/schemas\\\/healthcheckstatus_GET&quot;}}}}},&quot;security&quot;:[{&quot;api_key&quot;:[],&quot;Token&quot;:[]}],&quot;x-amazon-apigateway-integration&quot;:{&quot;type&quot;:&quot;aws&quot;,&quot;uri&quot;:{&quot;Fn::Sub&quot;:&quot;arn:aws:apigateway:${AWS::Region}:lambda:path\\\/2015-03-31\\\/functions\\\/${ttidtranslator}\\\/invocations&quot;},&quot;responses&quot;:{&quot;.*.400.*&quot;:{&quot;statusCode&quot;:&quot;400&quot;,&quot;responseParameters&quot;:{&quot;method.response.header.Access-Control-Allow-Origin&quot;:&quot;&#039;*&#039;&quot;,&quot;method.response.header.Strict-Transport-Security&quot;:&quot;&#039;max-age=31536000&#039;&quot;,&quot;method.response.header.Content-Security-Policy&quot;:&quot;&#039;frame-ancestors &#039;none&#039;&#039;&quot;,&quot;method.response.header.X-Content-Type-Options&quot;:&quot;&#039;nosniff&#039;&quot;,&quot;method.response.header.X-Frame-Options&quot;:&quot;&#039;deny&#039;&quot;,&quot;method.response.header.Referrer-Policy&quot;:&quot;&#039;same-origin&#039;&quot;},&quot;responseTemplates&quot;:{&quot;application\\\/json&quot;:&quot;#set ($errorMessageObj = $util.parseJson($input.path(&#039;$.errorMessage&#039;))){\\n    \\&quot;status\\&quot; : \\&quot;$errorMessageObj.status\\&quot;,\\n    \\&quot;status_message\\&quot; : \\&quot;$errorMessageObj.status_message\\&quot;,\\n    \\&quot;statusCode\\&quot;:400\\n}\\n&quot;}},&quot;default&quot;:{&quot;statusCode&quot;:&quot;200&quot;,&quot;responseParameters&quot;:{&quot;method.response.header.Access-Control-Allow-Origin&quot;:&quot;&#039;*&#039;&quot;,&quot;method.response.header.Strict-Transport-Security&quot;:&quot;&#039;max-age=31536000&#039;&quot;,&quot;method.response.header.Content-Security-Policy&quot;:&quot;&#039;frame-ancestors &#039;none&#039;&#039;&quot;,&quot;method.response.header.X-Content-Type-Options&quot;:&quot;&#039;nosniff&#039;&quot;,&quot;method.response.header.X-Frame-Options&quot;:&quot;&#039;deny&#039;&quot;,&quot;method.response.header.Referrer-Policy&quot;:&quot;&#039;same-origin&#039;&quot;}},&quot;.*.500.*&quot;:{&quot;statusCode&quot;:&quot;500&quot;,&quot;responseParameters&quot;:{&quot;method.response.header.Access-Control-Allow-Origin&quot;:&quot;&#039;*&#039;&quot;,&quot;method.response.header.Strict-Transport-Security&quot;:&quot;&#039;max-age=31536000&#039;&quot;,&quot;method.response.header.Content-Security-Policy&quot;:&quot;&#039;frame-ancestors &#039;none&#039;&#039;&quot;,&quot;method.response.header.X-Content-Type-Options&quot;:&quot;&#039;nosniff&#039;&quot;,&quot;method.response.header.X-Frame-Options&quot;:&quot;&#039;deny&#039;&quot;,&quot;method.response.header.Referrer-Policy&quot;:&quot;&#039;same-origin&#039;&quot;},&quot;responseTemplates&quot;:{&quot;application\\\/json&quot;:&quot;#set ($errorMessageObj = $util.parseJson($input.path(&#039;$.errorMessage&#039;))){\\n    \\&quot;status\\&quot; : \\&quot;$errorMessageObj.status\\&quot;,\\n    \\&quot;status_message\\&quot; : \\&quot;$errorMessageObj.status_message\\&quot;,\\n    \\&quot;statusCode\\&quot;:500\\n}\\n&quot;}}},&quot;requestTemplates&quot;:{&quot;application\\\/json&quot;:&quot;#set($inputJson = $input.json(&#039;$&#039;))\\n#set($environment = $input.path(&#039;$.environment&#039;))\\n{\\n\\&quot;httpMethod\\&quot;: \\&quot;GET\\&quot;,\\n\\&quot;stageVariables\\&quot;: {\\&quot;environment\\&quot;: \\&quot;$stageVariables.environment\\&quot; , \\n\\&quot;env\\&quot; : \\&quot;$stageVariables.env\\&quot;},\\n\\&quot;model\\&quot;: \\&quot;models\\\/healthcheckstatus_GET.json\\&quot;,\\n\\&quot;query\\&quot;: {\\n    #foreach($queryParam in $input.params().querystring.keySet())\\n    \\&quot;$queryParam\\&quot;: \\&quot;$util.escapeJavaScript($input.params().querystring.get($queryParam))\\&quot; #if($foreach.hasNext),#end\\n    #end},\\n\\&quot;headers\\&quot;: {\\n        #foreach($param in $input.params().header.keySet())\\n            \\&quot;$param\\&quot;: \\&quot;$util.escapeJavaScript($input.params().header.get($param))\\&quot;\\n        #if($foreach.hasNext),#end\\n        #end\\n    }\\n}&quot;},&quot;passthroughBehavior&quot;:&quot;when_no_templates&quot;,&quot;httpMethod&quot;:&quot;POST&quot;,&quot;contentHandling&quot;:&quot;CONVERT_TO_TEXT&quot;},&quot;description&quot;:&quot;Returns the functional status of the required systems for the REST API. This allows the user to send a frequent heartbeat to receive early notice if connectivity to an API endpoint responds with  400 or 500 errors. Once the GET request is sent, the endpoint returns the results as a JSON object. This returns the same system status displayed at &lt;a href=&#039;https:\\\/\\\/status.trade.tt\\\/&#039;&gt;https:\\\/\\\/status.trade.tt\\\/&lt;\\\/a&gt;.&quot;,&quot;summary&quot;:&quot;Gets the API Gateway status to confirm connectivity.&quot;},&quot;options&quot;:{&quot;responses&quot;:{&quot;200&quot;:{&quot;description&quot;:&quot;200 response&quot;,&quot;headers&quot;:{&quot;Access-Control-Allow-Origin&quot;:{&quot;schema&quot;:{&quot;type&quot;:&quot;string&quot;}},&quot;Access-Control-Allow-Methods&quot;:{&quot;schema&quot;:{&quot;type&quot;:&quot;string&quot;}},&quot;Access-Control-Allow-Headers&quot;:{&quot;schema&quot;:{&quot;type&quot;:&quot;string&quot;}},&quot;Strict-Transport-Security&quot;:{&quot;schema&quot;:{&quot;type&quot;:&quot;string&quot;}},&quot;Content-Security-Policy&quot;:{&quot;schema&quot;:{&quot;type&quot;:&quot;string&quot;}},&quot;X-Content-Type-Options&quot;:{&quot;schema&quot;:{&quot;type&quot;:&quot;string&quot;}},&quot;X-Frame-Options&quot;:{&quot;schema&quot;:{&quot;type&quot;:&quot;string&quot;}},&quot;Referrer-Policy&quot;:{&quot;schema&quot;:{&quot;type&quot;:&quot;string&quot;}}},&quot;content&quot;:{}}},&quot;x-amazon-apigateway-integration&quot;:{&quot;responses&quot;:{&quot;default&quot;:{&quot;statusCode&quot;:&quot;200&quot;,&quot;responseParameters&quot;:{&quot;method.response.header.Access-Control-Allow-Methods&quot;:&quot;&#039;DELETE,GET,HEAD,OPTIONS,PATCH,POST,PUT&#039;&quot;,&quot;method.response.header.Access-Control-Allow-Headers&quot;:&quot;&#039;Content-Type,Authorization,X-Amz-Date,X-Api-Key,X-Amz-Security-Token&#039;&quot;,&quot;method.response.header.Access-Control-Allow-Origin&quot;:&quot;&#039;*&#039;&quot;,&quot;method.response.header.Strict-Transport-Security&quot;:&quot;&#039;max-age=31536000&#039;&quot;,&quot;method.response.header.Content-Security-Policy&quot;:&quot;&#039;frame-ancestors &#039;none&#039;&#039;&quot;,&quot;method.response.header.X-Content-Type-Options&quot;:&quot;&#039;nosniff&#039;&quot;,&quot;method.response.header.X-Frame-Options&quot;:&quot;&#039;deny&#039;&quot;,&quot;method.response.header.Referrer-Policy&quot;:&quot;&#039;same-origin&#039;&quot;}}},&quot;requestTemplates&quot;:{&quot;application\\\/json&quot;:&quot;{\\&quot;statusCode\\&quot;: 200}&quot;},&quot;passthroughBehavior&quot;:&quot;when_no_match&quot;,&quot;type&quot;:&quot;mock&quot;}}}},&quot;components&quot;:{&quot;securitySchemes&quot;:{&quot;api_key&quot;:{&quot;type&quot;:&quot;apiKey&quot;,&quot;name&quot;:&quot;x-api-key&quot;,&quot;in&quot;:&quot;header&quot;},&quot;Token&quot;:{&quot;type&quot;:&quot;apiKey&quot;,&quot;name&quot;:&quot;Authorization&quot;,&quot;in&quot;:&quot;header&quot;}},&quot;schemas&quot;:{&quot;healthcheckstatus_GET&quot;:{&quot;_generated_&quot;:&quot;* This file is auto generated - do not modify by hand. *&quot;,&quot;metadata&quot;:{&quot;endpoint&quot;:{&quot;format&quot;:{},&quot;url&quot;:&quot;https:\\\/\\\/status.trade.tt\\\/api\\\/v1\\\/status&quot;},&quot;eventVars&quot;:{&quot;environment&quot;:[&quot;query&quot;,&quot;environment&quot;]},&quot;queryParams&quot;:{&quot;environment&quot;:{&quot;type&quot;:&quot;key&quot;,&quot;value&quot;:&quot;environment&quot;}}},&quot;properties&quot;:{&quot;environment&quot;:{&quot;description&quot;:&quot;&quot;,&quot;type&quot;:&quot;string&quot;},&quot;groups&quot;:{&quot;description&quot;:&quot;&quot;,&quot;items&quot;:{&quot;properties&quot;:{&quot;name&quot;:{&quot;description&quot;:&quot;&quot;,&quot;type&quot;:&quot;string&quot;},&quot;services&quot;:{&quot;description&quot;:&quot;&quot;,&quot;items&quot;:{&quot;properties&quot;:{&quot;components&quot;:{&quot;description&quot;:&quot;&quot;,&quot;items&quot;:{&quot;properties&quot;:{&quot;componentStatus&quot;:{&quot;description&quot;:&quot;&quot;,&quot;type&quot;:&quot;string&quot;},&quot;name&quot;:{&quot;description&quot;:&quot;&quot;,&quot;type&quot;:&quot;string&quot;}},&quot;type&quot;:&quot;object&quot;},&quot;type&quot;:&quot;array&quot;},&quot;name&quot;:{&quot;description&quot;:&quot;&quot;,&quot;type&quot;:&quot;string&quot;},&quot;serviceStatus&quot;:{&quot;description&quot;:&quot;&quot;,&quot;type&quot;:&quot;string&quot;}},&quot;type&quot;:&quot;object&quot;},&quot;type&quot;:&quot;array&quot;}},&quot;type&quot;:&quot;object&quot;},&quot;type&quot;:&quot;array&quot;},&quot;lastPage&quot;:{&quot;cast&quot;:&quot;lower&quot;,&quot;default&quot;:&quot;true&quot;,&quot;description&quot;:&quot;Whether this is the last page of the response.&quot;,&quot;type&quot;:&quot;string&quot;},&quot;lastUpdatedTime&quot;:{&quot;description&quot;:&quot;&quot;,&quot;type&quot;:&quot;string&quot;},&quot;status&quot;:{&quot;description&quot;:&quot;Response status.&quot;,&quot;type&quot;:&quot;string&quot;},&quot;systemStatus&quot;:{&quot;description&quot;:&quot;&quot;,&quot;type&quot;:&quot;string&quot;}},&quot;title&quot;:&quot;healthcheckstatus_GET&quot;,&quot;type&quot;:&quot;object&quot;}}},&quot;x-amazon-apigateway-gateway-responses&quot;:{&quot;DEFAULT_4XX&quot;:{&quot;responseParameters&quot;:{&quot;gatewayresponse.header.Strict-Transport-Security&quot;:&quot;&#039;max-age=31536000&#039;&quot;,&quot;gatewayresponse.header.Content-Security-Policy&quot;:&quot;&#039;frame-ancestors &#039;none&#039;&#039;&quot;,&quot;gatewayresponse.header.method.response.header.Referrer-Policy&quot;:&quot;&#039;same-origin&#039;&quot;,&quot;gatewayresponse.header.method.response.header.X-Frame-Options&quot;:&quot;&#039;deny&#039;&quot;,&quot;gatewayresponse.header.method.response.header.X-Content-Type-Options&quot;:&quot;&#039;nosniff&#039;&quot;},&quot;responseTemplates&quot;:{&quot;application\\\/json&quot;:&quot;{\\&quot;message\\&quot;:$context.error.messageString}&quot;}},&quot;DEFAULT_5XX&quot;:{&quot;responseParameters&quot;:{&quot;gatewayresponse.header.Strict-Transport-Security&quot;:&quot;&#039;max-age=31536000&#039;&quot;,&quot;gatewayresponse.header.Content-Security-Policy&quot;:&quot;&#039;frame-ancestors &#039;none&#039;&#039;&quot;,&quot;gatewayresponse.header.method.response.header.Referrer-Policy&quot;:&quot;&#039;same-origin&#039;&quot;,&quot;gatewayresponse.header.method.response.header.X-Frame-Options&quot;:&quot;&#039;deny&#039;&quot;,&quot;gatewayresponse.header.method.response.header.X-Content-Type-Options&quot;:&quot;&#039;nosniff&#039;&quot;},&quot;responseTemplates&quot;:{&quot;application\\\/json&quot;:&quot;{\\&quot;message\\&quot;:$context.error.messageString}&quot;}}}},&quot;docExpansion&quot;:&quot;list&quot;,&quot;defaultModelRendering&quot;:&quot;example&quot;,&quot;operationsSorter&quot;:&quot;alpha&quot;,&quot;deepLinking&quot;:true,&quot;displayOperationId&quot;:false,&quot;filter&quot;:false,&quot;tryItOutEnabled&quot;:false,&quot;defaultModelsExpandDepth&quot;:-1,&quot;validatorUrl&quot;:&quot;none&quot;}\"><\/div>","protected":false},"excerpt":{"rendered":"<p>The ttid service of the TT REST API is used to assist in creating users. Requests to the ttid service of the T [&hellip;]<\/p>\n","protected":false},"author":2,"template":"single-item-doc-uat","meta":{"_acf_changed":true,"footnotes":""},"docs-category":[737],"class_list":["post-7955","doc","type-doc","status-publish","hentry","docs-category-api-reference-tt-rest-api-2-0-uat"],"acf":[],"_links":{"self":[{"href":"https:\/\/library-staging.tradingtechnologies.com\/ja\/wp-json\/wp\/v2\/doc\/7955","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\/7955\/revisions"}],"wp:attachment":[{"href":"https:\/\/library-staging.tradingtechnologies.com\/ja\/wp-json\/wp\/v2\/media?parent=7955"}],"wp:term":[{"taxonomy":"docs-category","embeddable":true,"href":"https:\/\/library-staging.tradingtechnologies.com\/ja\/wp-json\/wp\/v2\/docs-category?post=7955"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}