The TT REST API gives you the tools you need to leverage the power of the TT platform within your own applications. You can access the same product information services, risk management and market connectivity used by the TT platform - all through an easy-to-use REST API.
The TT REST API provide a number of resources:
To view a sample application which makes use of the TT REST API, visit TT's public Github repository.
All requests to the TT REST API require the inclusion of an application key in their header. In addition, some services, such as Risk, also require a token.
The application key and the application key secret used to generate the token must be created in Setup.
Using the TT REST API requires you to select a usage plan for the application key that can incur additional costs. For more information about the costs associated with the usage plans, contact TT Customer Success.
Note: The application key and token are also used to make test requests from within the TT REST API documentation.
Note: Creating TT REST API application keys requires company administrators to enable the Can create TT Rest API key setting for the user.
Users can create application keys and receive their application secret from within Setup in the TT Platform:
To create an application key:
The key name must be unique.
Note: In the UAT testing environment, only the free plan is available. In the Live environment, only the Low, Medium and High plans are available.
The application key is generated and the application secret is displayed in the Secret field.
Click Copy Secret to Clipboard and then paste this application secret somewhere on your machine.
Warning: This is the only time you will be able to copy your new key's secret.
You can now use this application key to make requests to the TT REST API from your application as well as use the application secret to generate a token.
Requests to the TT REST API use the following base URL: apigateway.trade.tt/<service>/<environment>.
TT REST places the following limits on messages:
If you need help with TT REST API issues, you can submit a support ticket. To submit a support ticket, visit TT Support Center page in Resources section of the TT website and click Submit Incident.
To get a token, you send your application key and application secret within a POST request to generate a token. Expand the '/token' documentation below to view the required parameters for generating a token.
You can send a test request by clicking the "Try it out" button, entering your application key (Fig. 1) and application secret (Fig. 2) where prompted, and then clicking "Execute."
Note: Tokens are set to expire after a given period of time. This period of time is communicated in the response including your token as the "seconds_until_expiry" value. Your application will need to generate a new token before its token expires.