Skip to navigation

Open Demo Account

View as Markdown

Request to open a Demo account for a user.

Note: The /user/createEvaluationAccounts endpoint replaces /user/openDemoAccount and /user/createTradingPermission.

Typically used by B2B Partners to open simulation accounts for their users.

  • The defaultAutoLiq field controls the auto-liquidation paramters for the account. Setting it here will save an API call to userAccountAutoLiq/update, and should be preferred. It also prevents issues related to incorrect SOD balance when called during market close.
  • The preTradeRisk field allows you to wrap userAccountPositionLimit/create and userAccountRiskParameter/create calls into the account creation operation. This can save many API calls if you have complicated pre-trade risk settings to apply for your users.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
templateAccountIdlongOptional
namestringOptional<=64 characters
initialBalancedoubleOptional
defaultAutoLiqobjectOptional
preTradeRisklist of objectsOptional

Response

OpenDemoAccountResponse
errorTextstringOptional<=8192 characters

Non-empty if the request failed

accountIdlongOptional