Skip to main content

Get Account Templates

info
Documentation on this page is applicable to platforms that have Account Templates enabled. If you are unsure whether you have Account Templates enabled, please contact your account manager.

Description​

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.

You may retrieve details on an Account Template using the following APIs:

Get all Account Templates​

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

API Reference: /AccountTemplate

Example Request​

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

Example Response​

[
    {
        "name": "TEMPLATE_NAME",
        "notes": "Starting Balance: $100,000\nProfit Target: $6,000\nMax Loss: $2,500 (Trailing EOD highest account balance)\nDaily Loss: $1,000 (temporary violation - non fail)\nMax Position: 10 contracts ($100,000 margin)",
        "isActive": false,
        "id": 2,
        "title": "TEMPLATE_TITLE",
        "titleColor": "#ff0000",
        "description": "100K Account Template",
        "startingBalance": 100000,
        "margin": 100000,
        "tag": 0      // 0 = Regular Template, 1 = Practce Template
    }
]

Get Account Template from its Id​

API URL: GET https://userapi-demo.s2f.projectx.com/AccountTemplate/id/{accountTemplateId}

API Reference: /AccountTemplate/id/{accountTemplateId}

Retrieves an Account Template from its id.

Parameters​

NameTypeDescriptionRequiredNullable
idintegerThe Account Template's id.truefalse

Example Usage​

Example Request​

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

Example Response​

{
    "name": "TEMPLATE_NAME",
    "notes": "Starting Balance: $100,000\nProfit Target: $6,000\nMax Loss: $2,500 (Trailing EOD highest account balance)\nDaily Loss: $1,000 (temporary violation - non fail)\nMax Position: 10 contracts ($100,000 margin)",
    "isActive": false,
    "id": 2,
    "title": "TEMPLATE_TITLE",
    "titleColor": "#ff0000",
    "description": "100K Account Template",
    "startingBalance": 100000,
    "margin": 100000,
    "tag": 0      // 0 = Regular Template, 1 = Practce Template
}