### Manage Company Product Margins (ttsetup API) Source: https://library.tradingtechnologies.com/tt-rest/v2/gs-migrate Handles company product margin configurations via the TT REST API setup service. The '/company/productmargin' endpoint (both POST and DELETE) is deprecated and replaced by '/company/productmargins'. ```HTTP POST /company/productmargin ``` ```HTTP DELETE /company/productmargin ``` -------------------------------- ### OPTIONS Requests for TT Setup Data Source: https://library.tradingtechnologies.com/tt-rest/v2/_uat/ttsetup Provides options for TT setup data endpoints. These requests specify the operations available for TT setup configurations. ```HTTP OPTIONS /ttsetupdata ``` -------------------------------- ### TTACCOUNT - GET Endpoints Source: https://library.tradingtechnologies.com/tt-rest/v2/gs-migrate Details on GET endpoints for account information, children, limits, and risk settings. ```APIDOC ## GET /accounts ### Description Retrieves a list of accounts. The `parentId` field is deprecated and replaced with `parentAccountId`. ### Method GET ### Endpoint /accounts ### Parameters #### Query Parameters None ### Request Example None ### Response #### Success Response (200) - **parentAccountId** (string) - The ID of the parent account. #### Response Example ```json [ { "accountId": "acc123", "parentAccountId": "parentAcc456" } ] ``` ``` ```APIDOC ## GET /account/{accountId} ### Description Retrieves details for a specific account. Changes include: `riskSettings.dailyCreditLimit` type from string to number, `riskSettings.positionResetTime` default value set to 0, and `riskSettings.positionResetTimeZone` default value set to None. ### Method GET ### Endpoint /account/{accountId} ### Parameters #### Path Parameters - **accountId** (string) - Required - The ID of the account. ### Request Example None ### Response #### Success Response (200) - **riskSettings.dailyCreditLimit** (number) - The daily credit limit. - **riskSettings.positionResetTime** (integer) - The time for position reset. - **riskSettings.positionResetTimeZone** (string) - The time zone for position reset. #### Response Example ```json { "riskSettings": { "dailyCreditLimit": 50000, "positionResetTime": 0, "positionResetTimeZone": "None" } } ``` ``` ```APIDOC ## GET /account/{accountId}/children ### Description Retrieves the child accounts for a given account. The `lastPage` value has been changed from `True` to `true`, and `parentId` is deprecated in favor of `parentAccountId`. ### Method GET ### Endpoint /account/{accountId}/children ### Parameters #### Path Parameters - **accountId** (string) - Required - The ID of the account. ### Request Example None ### Response #### Success Response (200) - **lastPage** (boolean) - Indicates if this is the last page of results. - **parentAccountId** (string) - The ID of the parent account. #### Response Example ```json [ { "accountId": "childAcc789", "parentAccountId": "acc123", "lastPage": true } ] ``` ``` ```APIDOC ## GET /account/{accountId}/limits ### Description Retrieves the limits for a specific account. Certain `productLimits` fields have been updated: `outright_rejectOrderExceedingLevelDepth` to `rejectOrderExceedingLevelDepth`, `outright_marketDepthCheck` to `marketDepthCheck`, and `outright_maxChildSliceSize` to `maxChildSliceSize`. ### Method GET ### Endpoint /account/{accountId}/limits ### Parameters #### Path Parameters - **accountId** (string) - Required - The ID of the account. ### Request Example None ### Response #### Success Response (200) - **productLimits.rejectOrderExceedingLevelDepth** (boolean) - Flag to reject orders exceeding level depth. - **productLimits.marketDepthCheck** (boolean) - Flag for market depth check. - **productLimits.maxChildSliceSize** (integer) - Maximum size for child slices. #### Response Example ```json { "productLimits": { "rejectOrderExceedingLevelDepth": true, "marketDepthCheck": false, "maxChildSliceSize": 10 } } ``` ``` ```APIDOC ## GET /account/{accountId}/risksettings ### Description Retrieves the risk settings for a specific account. Changes include: `riskSettings.dailyCreditLimit` type from string to number, `riskSettings.positionResetTime` default value set to 0, and `riskSettings.positionResetTimeZone` default value set to None. ### Method GET ### Endpoint /account/{accountId}/risksettings ### Parameters #### Path Parameters - **accountId** (string) - Required - The ID of the account. ### Request Example None ### Response #### Success Response (200) - **riskSettings.dailyCreditLimit** (number) - The daily credit limit. - **riskSettings.positionResetTime** (integer) - The time for position reset. - **riskSettings.positionResetTimeZone** (string) - The time zone for position reset. #### Response Example ```json { "riskSettings": { "dailyCreditLimit": 50000, "positionResetTime": 0, "positionResetTimeZone": "None" } } ``` ``` ```APIDOC ## GET /accountuser ### Description Retrieves account user information. The `LastPage` variable has been renamed to `lastPage`. ### Method GET ### Endpoint /accountuser ### Parameters #### Query Parameters None ### Request Example None ### Response #### Success Response (200) - **lastPage** (any) - The last page identifier. #### Response Example ```json [ { "userId": "user123", "lastPage": "pageABC" } ] ``` ``` -------------------------------- ### GET /products Source: https://library.tradingtechnologies.com/tt-rest/v2/ttpds Gets a list of products for a given market. Supports authentication via API key or token. ```APIDOC ## GET /products ### Description Gets a list of products for a given market. This endpoint is secured and requires authentication. ### Method GET ### Endpoint /products ### Parameters #### Query Parameters - **param1** (type) - Required/Optional - Description #### Request Body - **environment** (string) - Required - Specifies the environment for the request. ### Request Example ```json { "environment": "production" } ``` ### Response #### Success Response (200) - **response body** (object) - Contains a list of products. The exact structure is defined by the schema used in the integration request templates. #### Response Example ```json { "example": "response body" } ``` #### Error Response (400) - **status** (string) - The status code of the error. - **status_message** (string) - A message describing the error. - **statusCode** (integer) - The HTTP status code for the error. #### Error Response Example ```json { "status": "error", "status_message": "Invalid request parameters", "statusCode": 400 } ``` ``` -------------------------------- ### Retrieve Common Data (ttsetup API) Source: https://library.tradingtechnologies.com/tt-rest/v2/gs-migrate Fetches common data using the TT REST API setup service. The '/commondata' endpoint is deprecated and replaced by '/ttcommondata'. ```HTTP GET /commondata ``` -------------------------------- ### API Base URL Examples Source: https://library.tradingtechnologies.com/tt-rest/v2/_uat/ttaccount Provides examples of base URLs for accessing the ttaccount service in different environments (UAT and production). Case sensitivity is crucial for endpoint names. ```text https://ttrestapi.trade.tt/ttaccount/ext_uat_cert https://ttrestapi.trade.tt/ttaccount/ext_prod_live ``` -------------------------------- ### Example GUID Format Source: https://library.tradingtechnologies.com/tt-rest/v2/gs-token Provides an example of a valid Globally Unique Identifier (GUID) format as required for the 'requestId' parameter. ```GUID 47a1e1c4-0c94-4fb3-94a9-d772382458a3 ``` -------------------------------- ### POST /algobacktests/ Source: https://library.tradingtechnologies.com/tt-rest/v2/ttbacktest Initiates a new algorithmic backtest. This endpoint requires detailed configuration including the algorithm ID, user parameters, replay settings, and market data. ```APIDOC ## POST /algobacktests/ ### Description Starts a new algorithmic backtest. ### Method POST ### Endpoint https://algo-backtesting-{env}.trade.tt/algobacktests/ ### Parameters #### Request Body - **algoId** (string) - Required - The identifier of the algorithm to backtest. - **userParameters** (array) - Required - An array of user-defined parameters for the algorithm. Each parameter is an object with `name`, `displayName`, and a value field (e.g., `doubleValue`, `boolValue`, `stringValue`, `integerValue`, `timestampValue`). - **replaySpeed** (number) - Required - The speed at which the backtest should be replayed. - **startTime** (integer) - Required - The start timestamp for the backtest replay. - **stopTime** (integer) - Required - The stop timestamp for the backtest replay. - **marketId** (integer) - Required - The identifier of the market for the backtest. - **replayInstruments** (array) - Required - A list of instruments to be used in the backtest. - **algoType** (string) - Optional - The type of the algorithm. - **accountId** (integer) - Optional - The account ID associated with the backtest. ### Request Example ```json { "algoId": "my-trading-algo-v1", "userParameters": [ { "name": "rsiThreshold", "displayName": "RSI Threshold", "type": 0, "integerValue": 30 }, { "name": "useStopLoss", "displayName": "Use Stop Loss", "type": 1, "boolValue": true } ], "replaySpeed": 1.0, "startTime": 1678886400, "stopTime": 1678972800, "marketId": 101, "replayInstruments": ["ESZ23", "NQZ23"], "algoType": "momentum", "accountId": 12345 } ``` ### Response *(Note: The response for POST requests typically confirms initiation and may include a backtest ID. Specific details depend on implementation.)* #### Success Response (201) - **status** (string) - Indicates the operation status (e.g., 'processing', 'created'). - **backtestId** (string) - The unique ID assigned to the newly created backtest. #### Response Example ```json { "status": "processing", "backtestId": "bt-a1b2c3d4e5f6" } ``` ``` -------------------------------- ### GET /sod/{accountId} Source: https://library.tradingtechnologies.com/tt-rest/v2/_uat/ttmonitor Gets SODs (start of day positions) for a given account ID. ```APIDOC ## GET /sod/{accountId} ### Description Gets SODs (start of day positions) for a given account ID. ### Method GET ### Endpoint /sod/{accountId} ### Parameters #### Path Parameters - **accountId** (string) - Required - The ID of the account for which to retrieve SODs. #### Query Parameters - **x-api-key** (string) - Required - Your application key. - **Authorization** (string) - Required - Your token, prefixed with "Bearer ". ### Response #### Success Response (200) - **sods** (array) - An array of SOD objects for the specified account. - **product** (string) - The product identifier. - **quantity** (number) - The SOD quantity. - **price** (number) - The SOD price. #### Response Example ```json { "sods": [ { "product": "ES", "quantity": 100, "price": 3990.00 } ] } ``` ``` -------------------------------- ### TTSETUP Service Endpoints Source: https://library.tradingtechnologies.com/tt-rest/v2/_uat/gs-migrate Endpoints for the TTSETUP service, managing common data, company settings, and order tags. ```APIDOC ## GET /commondata ### Description Deprecated. Use `/ttcommondata` instead. Retrieves common data. ### Method GET ### Endpoint /commondata ## GET /company ### Description Retrieves company information. ### Method GET ### Endpoint /company ## GET /ordertagdefaults/fields ### Description Retrieves default order tag fields. The `lastPage` field value has changed from `True` to `true`. ### Method GET ### Endpoint /ordertagdefaults/fields ## GET /organizations ### Description Retrieves organization information. ### Method GET ### Endpoint /organizations ## GET /report ### Description Retrieves report data. ### Method GET ### Endpoint /report ## GET /ttcommondata ### Description Retrieves common data. This endpoint replaces the deprecated `/commondata` endpoint. ### Method GET ### Endpoint /ttcommondata ## GET /connections ### Description Retrieves connection information. ### Method GET ### Endpoint /connections ## POST /company/productmargin ### Description Deprecated. Use `/company/productmargins` instead. Updates product margin information for a company. ### Method POST ### Endpoint /company/productmargin ## POST /company/productmargins ### Description Updates product margin information for a company. This endpoint replaces the deprecated `/company/productmargin` endpoint. ### Method POST ### Endpoint /company/productmargins ## POST /ordertagdefaults/profiles ### Description Manages order tag default profiles. The `customerId` field is deprecated and replaced by `profileId`. ### Method POST ### Endpoint /ordertagdefaults/profiles ## DELETE /company/productmargin ### Description Deprecated. Use `/company/productmargins` instead. Deletes product margin information for a company. ### Method DELETE ### Endpoint /company/productmargin ## DELETE /company/productmargins ### Description Deletes product margin information for a company. This endpoint replaces the deprecated `/company/productmargin` endpoint. ### Method DELETE ### Endpoint /company/productmargins ``` -------------------------------- ### ttuser Service Overview Source: https://library.tradingtechnologies.com/tt-rest/v2/_uat/ttuser Provides information on accessing and using the ttuser service, including base URLs for testing and production, limitations for POST requests, and required access parameters (Application Key and Token). ```APIDOC ## TT REST API 2.0 - ttuser Service ### Description The ttuser service of the TT REST API is used for requests pertaining to risk limits, market data access, contracts, and product settings for given users or user groups. ### Base URLs - **Testing:** `https://ttrestapi.trade.tt/ttuser/ext_uat_cert` - **Production:** `https://ttrestapi.trade.tt/ttuser/ext_prod_live` **Note:** All API URLs are case-sensitive and should use lowercase endpoint names. ### POST Request Limitations - POST endpoints accepting lists are limited to twenty items per list. - A one-second pause is required after receiving acknowledgement for a prior POST submission. - For large data uploads or migrations, contact TT Onboarding for scheduling assistance. ### Required Headers - **Application Key:** `x-api-key=` - **Token:** `Authorization=Bearer ` Refer to the TT REST Web Services documentation for obtaining these credentials. ### Test Calls Test calls can be made using the following base URL: `https://ttrestapi.trade.tt/ttuser/ext_uat_cert`. **Note:** When providing the token, prepend "Bearer " to the token value. ``` -------------------------------- ### TTUSER - GET Endpoints Source: https://library.tradingtechnologies.com/tt-rest/v2/gs-migrate Details on GET endpoints for user information, access lines, private lines, and risk limits. ```APIDOC ## GET /user ### Description Retrieves user information. The PrimaryPhoneExt and SecPhoneExt fields have been updated from integer to string. ### Method GET ### Endpoint /user ### Parameters #### Query Parameters None ### Request Example None ### Response #### Success Response (200) - **PrimaryPhoneExt** (string) - The primary phone extension. - **SecPhoneExt** (string) - The secondary phone extension. #### Response Example { "PrimaryPhoneExt": "123", "SecPhoneExt": "456" } ``` ```APIDOC ## GET /user/accesslines ### Description Retrieves user access lines. The revision field type has changed from string to integer. ### Method GET ### Endpoint /user/accesslines ### Parameters #### Query Parameters None ### Request Example None ### Response #### Success Response (200) - **revision** (integer) - The revision number of the access lines. #### Response Example { "revision": 1 } ``` ```APIDOC ## GET /user/privatelines ### Description This endpoint is deprecated and has been replaced by `/user/accesslines`. ### Method GET ### Endpoint /user/privatelines ### Parameters None ### Request Example None ### Response None ``` ```APIDOC ## GET /user/{userId} ### Description Retrieves a specific user's information. The `last_page` and `next_page_key` fields are deprecated and replaced with `lastPage` and `nextPageKey` respectively. ### Method GET ### Endpoint /user/{userId} ### Parameters #### Path Parameters - **userId** (string) - Required - The ID of the user. ### Request Example None ### Response #### Success Response (200) - **lastPage** (any) - The last page identifier. - **nextPageKey** (string) - The key for the next page of results. #### Response Example { "lastPage": "page123", "nextPageKey": "nextKey456" } ``` ```APIDOC ## GET /user/{userId}/risklimits ### Description This endpoint is deprecated and has been replaced by `/user/{userId}/limits`. ### Method GET ### Endpoint /user/{userId}/risklimits ### Parameters #### Path Parameters - **userId** (string) - Required - The ID of the user. ### Request Example None ### Response None ``` ```APIDOC ## GET /user/{userId}/marketdata ### Description Retrieves market data for a user. The `last_page` field is deprecated and replaced with `lastPage`. ### Method GET ### Endpoint /user/{userId}/marketdata ### Parameters #### Path Parameters - **userId** (string) - Required - The ID of the user. ### Request Example None ### Response #### Success Response (200) - **lastPage** (any) - The last page identifier. #### Response Example { "lastPage": "page789" } ``` ```APIDOC ## GET /user/{userId}/profile ### Description Retrieves the profile information for a user. The `last_page` field is deprecated and replaced with `lastPage`. ### Method GET ### Endpoint /user/{userId}/profile ### Parameters #### Path Parameters - **userId** (string) - Required - The ID of the user. ### Request Example None ### Response #### Success Response (200) - **lastPage** (any) - The last page identifier. #### Response Example { "lastPage": "page101" } ``` -------------------------------- ### OPTIONS Requests for Counterparty Data Source: https://library.tradingtechnologies.com/tt-rest/v2/_uat/ttsetup Provides options for various counterparty-related endpoints. These requests outline the permissible actions for counterparty management. ```HTTP OPTIONS /counterparties ``` ```HTTP OPTIONS /counterparties/{counterpartyId} ``` -------------------------------- ### TTGROUP - GET Endpoints Source: https://library.tradingtechnologies.com/tt-rest/v2/gs-migrate This section details GET endpoints related to TTGROUP, focusing on retrieving risk group and user group information. ```APIDOC ## GET /riskgroups ### Description Retrieves risk groups. The `productLimits->environment` field has been removed, and the type of `riskSettings->dailyCreditLimit` has changed from string to number. ### Method GET ### Endpoint /riskgroups ``` ```APIDOC ## GET /riskgroups/{riskgroupid}/limits ### Description Retrieves limits for a specific risk group. The `productLimits->environment` field has been removed, the type of `riskSettings->dailyCreditLimit` has changed from string to number, and empty string default values for `interProductLimits->productid` and `contractLimits->instrumentMaturity` have been removed. Additionally, the type of `contractLimits->instrumentMaturity` has changed from integer to string. ### Method GET ### Endpoint /riskgroups/{riskgroupid}/limits ``` ```APIDOC ## GET /usergroups/{userGroupId} ### Description Retrieves user group information. The `privateLines` and `settings` objects have been removed. ### Method GET ### Endpoint /usergroups/{userGroupId} ``` ```APIDOC ## GET /usergroups/{userGroupId}/connectivity ### Description Deprecated endpoint for user group connectivity. This endpoint has been removed. ### Method GET ### Endpoint /usergroups/{userGroupId}/connectivity ``` ```APIDOC ## GET /usergroups/{userGroupId}/settings ### Description Deprecated endpoint for user group settings. This endpoint has been removed. ### Method GET ### Endpoint /usergroups/{userGroupId}/settings ``` -------------------------------- ### GET Start of Day (SOD) Records Source: https://library.tradingtechnologies.com/tt-rest/v2/_uat/ttmonitor Retrieves Start of Day (SOD) records for a given account ID. This endpoint is crucial for accessing daily account summaries. ```HTTP GET /sod/{accountId} ``` -------------------------------- ### Counterparties API Source: https://library.tradingtechnologies.com/tt-rest/v2/_uat/ttsetup Endpoints for managing counterparties, including creation, retrieval, and deletion. ```APIDOC ## POST /counterparties ### Description Creates new counterparties. ### Method POST ### Endpoint /counterparties ``` ```APIDOC ## GET /counterparties ### Description Gets a list of all counterparties for a company. ### Method GET ### Endpoint /counterparties ``` ```APIDOC ## DELETE /counterparties/{counterpartyId} ### Description Deletes a counterparty given a counterparty ID. ### Method DELETE ### Endpoint /counterparties/{counterpartyId} ### Parameters #### Path Parameters - **counterpartyId** (string) - Required - The ID of the counterparty to delete. ``` -------------------------------- ### Create Counterparties (POST /counterparties) Source: https://library.tradingtechnologies.com/tt-rest/v2/_uat/ttsetup Creates new counterparties within the system. This endpoint is essential for onboarding new trading partners or entities. ```HTTP POST /counterparties ``` -------------------------------- ### Get User Market Data Permissions - TT REST API v2 Source: https://library.tradingtechnologies.com/tt-rest/v2/_uat/ttuser Gets a list of subscriber market data permissions defined for a user in the Setup module. ```HTTP GET /user/{userId}/marketdata ``` -------------------------------- ### Get TT Setup Data (GET /ttsetupdata) Source: https://library.tradingtechnologies.com/tt-rest/v2/_uat/ttsetup Provides definitions for enums used by the Risk service endpoints. This is crucial for understanding and correctly using enum values in API requests. ```HTTP GET /ttsetupdata ``` -------------------------------- ### POST /websites/library_tradingtechnologies_tt-rest_v2/algobacktest Source: https://library.tradingtechnologies.com/tt-rest/v2/ttbacktest Initiates a new algo backtest. ```APIDOC ## POST /websites/library_tradingtechnologies_tt-rest_v2/algobacktest ### Description Initiates a new algorithmic backtest. Requires details about the algorithm and replay parameters. ### Method POST ### Endpoint /websites/library_tradingtechnologies_tt-rest_v2/algobacktest ### Parameters #### Request Body - **replayInstruments** (array) - Required - List of instruments for replay. - **replaySpeed** (number) - Required - Speed of the replay. - **userParameters** (array) - Optional - User-defined parameters for the algorithm. - **displayName** (string) - Display name for the parameter. - **name** (string) - Name of the parameter. - **doubleValue** (number) - Double value for the parameter. - **boolValue** (boolean) - Boolean value for the parameter. - **stringValue** (string) - String value for the parameter. - **type** (integer) - Type of the parameter. - **integerValue** (integer) - Integer value for the parameter. - **timestampValue** (integer) - Timestamp value for the parameter. - **userId** (integer) - Required - User ID. - **algoId** (string) - Required - Algorithm ID. - **backtestStatus** (string) - Required - Initial status of the backtest. - **dateCreated** (string) - Required - Timestamp when the backtest was created. - **replayTime** (object) - Required - Time range for the replay. - **stopTime** (integer) - End time for the replay. - **startTime** (integer) - Start time for the replay. ### Request Example ```json { "replayInstruments": [ { "symbol": "ES", "exchange": "CME" } ], "replaySpeed": 1.0, "userParameters": [ { "displayName": "Take Profit", "name": "tp", "type": 3, "integerValue": 10 } ], "userId": 1001, "algoId": "algo_abc", "backtestStatus": "PENDING", "dateCreated": "2023-10-27T10:00:00Z", "replayTime": { "startTime": 1678886400, "stopTime": 1678972800 } } ``` ### Response #### Success Response (200) - **status** (string) - Response status. - **statusCode** (integer) - The returned status code. - **status_message** (string) - Populated when an error occurs to provide further details. - **backtest** (object) - Details of the created backtest. - **replayInstruments** (array) - Instruments used for replay. - **replaySpeed** (number) - Speed of the replay. - **userParameters** (array) - User parameters. - **userId** (integer) - User ID. - **algoId** (string) - Algorithm ID. - **backtestStatus** (string) - Status of the backtest. - **dateCreated** (string) - Timestamp when the backtest was created. - **replayTime** (object) - Time range for the replay. - **startedAt** (string) - Timestamp when the backtest started. - **dateFinished** (string|null) - Timestamp when the backtest finished. - **id** (string) - Unique identifier for the backtest. - **requestVersion** (integer) - For TT internal use only. #### Response Example ```json { "status": "success", "statusCode": 200, "status_message": "", "backtest": { "replayInstruments": [ { "symbol": "ES", "exchange": "CME" } ], "replaySpeed": 1.0, "userParameters": [ { "displayName": "Take Profit", "name": "tp", "type": 3, "integerValue": 10 } ], "userId": 1001, "algoId": "algo_abc", "backtestStatus": "PENDING", "dateCreated": "2023-10-27T10:00:00Z", "replayTime": { "startTime": 1678886400, "stopTime": 1678972800 }, "startedAt": null, "dateFinished": null, "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef" }, "requestVersion": 1 } ``` ``` -------------------------------- ### Mock Integration for Market Data Options Source: https://library.tradingtechnologies.com/tt-rest/v2/ttbacktest Defines the mock integration options for the /marketdata endpoint, including request templates and response configurations for API Gateway. ```json { "options": { "x-amazon-apigateway-integration": { "requestTemplates": { "application/json": "{\"statusCode\": 200}" }, "passthroughBehavior": "when_no_match", "type": "mock", "responses": { "default": { "statusCode": "200", "responseParameters": { "method.response.header.Access-Control-Allow-Origin": "'*'", "method.response.header.Access-Control-Allow-Methods": "'DELETE,GET,HEAD,OPTIONS,PATCH,POST,PUT'", "method.response.header.Access-Control-Allow-Headers": "'Content-Type,Authorization,X-Amz-Date,X-Api-Key,X-Amz-Security-Token'" } } } }, "responses": { "200": { "content": {}, "headers": { "Access-Control-Allow-Origin": { "schema": { "type": "string" } }, "Access-Control-Allow-Methods": { "schema": { "type": "string" } }, "Access-Control-Allow-Headers": { "schema": { "type": "string" } } }, "description": "200 response" } }, "parameters": [ { "required": true, "in": "path", "name": "backtestId", "schema": { "type": "string" }, "description": "Key used to request and identify a specific backtest. This hexadecimal value matches the format: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.

Use the /algobacktest endpoint to retrieve a list of all available backtests and their associated backtestId.

" } ] } } ``` -------------------------------- ### API Gateway Request Parameters for Algo User Parameters GET Source: https://library.tradingtechnologies.com/tt-rest/v2/ttpds Defines request parameters for the GET endpoint of the `/algos/{algoId}/userparameters` resource. It specifies query parameters like `requestId` with their types, examples, and descriptions. ```json { "required": "true", "in": "query", "name": "requestId", "schema": { "type": "string" }, "example": "myApp-myCompany--4037847b-de40-46c8-b55e-66186d657614", "description": "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 requestId query parameter for all requests.
The TT REST API documentation pre-populates a sample requestId which can only be used when making test calls." } ``` -------------------------------- ### TTACCOUNT - GET Endpoints Source: https://library.tradingtechnologies.com/tt-rest/v2/_uat/gs-migrate Endpoints for retrieving account information, children, limits, and risk settings. ```APIDOC ## GET /accounts ### Description Retrieves a list of accounts. The 'parentId' field has been deprecated and replaced with 'parentAccountId'. ### Method GET ### Endpoint /accounts ### Parameters ### Request Example ### Response #### Success Response (200) - **parentAccountId** (string) - The ID of the parent account. #### Response Example { "parentAccountId": "parent123" } ``` ```APIDOC ## GET /account/{accountId} ### Description Retrieves details for a specific account. Changes include dailyCreditLimit type to number, and default values for positionResetTime and positionResetTimeZone. ### Method GET ### Endpoint /account/{accountId} ### Parameters #### Path Parameters - **accountId** (string) - Required - The ID of the account. ### Request Example ### Response #### Success Response (200) - **riskSettings.dailyCreditLimit** (number) - The daily credit limit. - **riskSettings.positionResetTime** (integer) - The time for position reset. - **riskSettings.positionResetTimeZone** (string) - The time zone for position reset. #### Response Example { "riskSettings": { "dailyCreditLimit": 10000, "positionResetTime": 0, "positionResetTimeZone": "None" } } ``` ```APIDOC ## GET /account/{accountId}/children ### Description Retrieves child accounts for a specific account. The 'lastPage' value is now 'true' (lowercase), and 'parentId' is replaced with 'parentAccountId'. ### Method GET ### Endpoint /account/{accountId}/children ### Parameters #### Path Parameters - **accountId** (string) - Required - The ID of the account. ### Request Example ### Response #### Success Response (200) - **lastPage** (boolean) - Indicates if this is the last page of results. - **parentAccountId** (string) - The ID of the parent account. #### Response Example { "lastPage": true, "parentAccountId": "parent123" } ``` ```APIDOC ## GET /account/{accountId}/limits ### Description Retrieves limits for a specific account. Specific product limit fields have been updated. ### Method GET ### Endpoint /account/{accountId}/limits ### Parameters #### Path Parameters - **accountId** (string) - Required - The ID of the account. ### Request Example ### Response #### Success Response (200) - **productLimits.rejectOrderExceedingLevelDepth** (any) - Updated field for rejecting orders exceeding level depth. - **productLimits.marketDepthCheck** (any) - Updated field for market depth check. - **productLimits.maxChildSliceSize** (any) - Updated field for maximum child slice size. #### Response Example { "productLimits": { "rejectOrderExceedingLevelDepth": "value", "marketDepthCheck": "value", "maxChildSliceSize": "value" } } ``` ```APIDOC ## GET /account/{accountId}/risksettings ### Description Retrieves risk settings for a specific account. Changes include dailyCreditLimit type to number, and default values for positionResetTime and positionResetTimeZone. ### Method GET ### Endpoint /account/{accountId}/risksettings ### Parameters #### Path Parameters - **accountId** (string) - Required - The ID of the account. ### Request Example ### Response #### Success Response (200) - **riskSettings.dailyCreditLimit** (number) - The daily credit limit. - **riskSettings.positionResetTime** (integer) - The time for position reset. - **riskSettings.positionResetTimeZone** (string) - The time zone for position reset. #### Response Example { "riskSettings": { "dailyCreditLimit": 10000, "positionResetTime": 0, "positionResetTimeZone": "None" } } ``` ```APIDOC ## GET /accountuser ### Description Retrieves account user information. The 'LastPage' variable name has been changed to 'lastPage'. ### Method GET ### Endpoint /accountuser ### Parameters ### Request Example ### Response #### Success Response (200) - **lastPage** (any) - Information about the last page. #### Response Example { "lastPage": "someValue" } ``` -------------------------------- ### TTUSER - GET Endpoints Source: https://library.tradingtechnologies.com/tt-rest/v2/_uat/gs-migrate Endpoints for retrieving user information, access lines, and private lines. ```APIDOC ## GET /user ### Description Retrieves user information. The PrimaryPhoneExt and SecPhoneExt fields have been updated from integer to string. ### Method GET ### Endpoint /user ### Parameters ### Request Example ### Response #### Success Response (200) - **PrimaryPhoneExt** (string) - Primary phone extension. - **SecPhoneExt** (string) - Secondary phone extension. #### Response Example { "PrimaryPhoneExt": "123", "SecPhoneExt": "456" } ``` ```APIDOC ## GET /user/accesslines ### Description Retrieves user access lines. The 'revision' field type has been changed from string to integer. ### Method GET ### Endpoint /user/accesslines ### Parameters ### Request Example ### Response #### Success Response (200) - **revision** (integer) - Revision number. #### Response Example { "revision": 1 } ``` ```APIDOC ## GET /user/privatelines ### Description Deprecated endpoint. Replaced by /user/accesslines. ### Method GET ### Endpoint /user/privatelines ``` ```APIDOC ## GET /user/{userId} ### Description Retrieves a specific user's details. The 'last_page' and 'next_page_key' fields have been deprecated and replaced with 'lastPage' and 'nextPageKey' respectively. ### Method GET ### Endpoint /user/{userId} ### Parameters #### Path Parameters - **userId** (string) - Required - The ID of the user. ### Request Example ### Response #### Success Response (200) - **lastPage** (any) - Information about the last page. - **nextPageKey** (string) - Key for the next page. #### Response Example { "lastPage": "someValue", "nextPageKey": "nextKey" } ``` ```APIDOC ## GET /user/{userId}/risklimits ### Description Deprecated endpoint. Replaced by /user/{userId}/limits. ### Method GET ### Endpoint /user/{userId}/risklimits ### Parameters #### Path Parameters - **userId** (string) - Required - The ID of the user. ### Request Example ### Response #### Success Response (200) #### Response Example ``` ```APIDOC ## GET /user/{userId}/marketdata ### Description Retrieves market data for a specific user. The 'last_page' field has been deprecated and replaced with 'lastPage'. ### Method GET ### Endpoint /user/{userId}/marketdata ### Parameters #### Path Parameters - **userId** (string) - Required - The ID of the user. ### Request Example ### Response #### Success Response (200) - **lastPage** (any) - Information about the last page. #### Response Example { "lastPage": "someValue" } ``` ```APIDOC ## GET /user/{userId}/profile ### Description Retrieves the profile for a specific user. The 'last_page' field has been deprecated and replaced with 'lastPage'. ### Method GET ### Endpoint /user/{userId}/profile ### Parameters #### Path Parameters - **userId** (string) - Required - The ID of the user. ### Request Example ### Response #### Success Response (200) - **lastPage** (any) - Information about the last page. #### Response Example { "lastPage": "someValue" } ```