Skip to main content

Allocate Trading Account

Once you have successfully created a user, you must create a trading account so they may access and interact with the platform.

All trading accounts are created from a pre-existing Account Templates.

You may override specific template values such as starting balance, profit target, maximum position, etc. As of this writing, Account Templates are configured during your initial account setup and configuration. In the near future, we will be adding a graphical interface to your Admin panel as well as API functionality to add / edit / modify these templates. In the meantime, to add or modify Account Templates, please contact your account manager.

Account Template​

Retrieve Existing Account Templates​

API URL: GET https://userapi-demo.s2f.projectx.com/AccountTemplate

API Reference: /AccountTemplate

Before creating a user, you must select the Account Template to be used.

To retrieve a list of all available Account Templates, create a GET request to the trading account template endpoint referenced above.

Example Usage​

curl -X 'GET' \
  'https://userapi-demo.s2f.projectx.com/AccountTemplate' \
  -H 'accept: text/plain'

Create Your First SIM Account​

API Reference: /TradingAccount/createSimAccount

To create a trading account, you will need a a user ID (created here), a template ID (created here), an account name, and an internal tag.

Internal Tag​

  • Default (0)
    • This account belongs to a trader.
  • Internal (1)
    • This account belongs to an internal team member. Examples of internal team members include the development team, risk management team and support teams.

Example Usage​

This request will create a new trading account for a user with an ID 7, a template ID of 2, an account name of "EVALAPR1424", and an account type of "SIM."

{
  "userId": 0,
  "templateId": 0,
  "accountName": "string",
  "internalTag": 0
}

Notes​

Store the account ID and name within your platform and associate it with the user it was created for. Further Trading Account API requests will utilize either this ID or the account name in certain cases.