Skip to navigation

Create Evaluation Accounts

View as Markdown

Batch create up to 100 simulation accounts at once.

Available to: Organization administrators

Environments: Demo

Rate Limit: 100 requests per hour, 1-second back-off, counts failed requests only

This endpoint can help greatly reduce your application’s API usage footprint. It batches the functionality of several calls at once for each EvaluationAccount configuration object:

  • The userId field controls which user will be assigned a Trading Permission for this account once it is created.
  • Providing a preTradeRisk will allow you to apply userAccountPositionLimit and userAccountRiskParameter settings directly.
  • Providing a postTradeRisk will allow you to set the userAccountAutoLiq settings directly, including trailingMaxDrawdownMode. See Drawdown Modes for more information.

The name field for each account must use uppercase letters (A-Z) followed by one or more digits (0-9), with a maximum length of 64 characters. No lowercase letters, spaces, special characters, or underscores are allowed, and letters must come before digits. Valid examples: TESTACCOUNT123, SIMACCOUNT001. Invalid examples: abc123, ABC_123, A1B2C3.

If the name value doesn’t match the required format, the API returns HTTP 400 with a violations array:

{
"violations": [
{
"constraint": "name",
"value": "my_account_1",
"description": "Account name should follow the next regexp: ([A-Z])+\\d+"
}
]
}

Use this endpoint when creating new accounts to minimize API traffic.

Note: This endpoint replaces /user/openDemoAccount and /user/createTradingPermission.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
accountslist of objectsRequired

Response

CreateEvaluationAccountsResponse
resultslist of objects
errorTextstringOptional<=8192 characters

Non-empty if the request failed