User management

This section describes the User creation process with a minimal required set of parameters.

A full list of parameters available for user creation can be found here:

https://sandbox.traderevolution.com:8443/proftrading/rest/swagger-ui.html#/Users/createUserMethodUsingPOST

The newly created user should be assigned at least one trading account, so the request body contains user details and a section for specifying the account details. Please note that creating a user with minimal parameters requires only a name for your trading account. If a trader should have multiple accounts with different rules it is worth considering the account preset entity. If this is the case, during the account creation you need to specify the preset ID and it will automatically be applied to a newly created account.

You can check the list of all presets created on a server using the GET/accountPresets method or refer to a corresponding section of this doc for a more detailed description.

Also, the user should be allocated to a specific user group, please note that in this case, the user and his accounts inherit all settings from it.

The account is created with a server currency by default (Configuration > Settings > General) and is in an Active state (ready for trade after the deposit). New currency settings will be applied if they are overridden on the higher level.

In response, you will receive the ID of the newly created user/account, keep it on your side, because the account ID will be used in your following requests, i.e. to perform deposit or other account operations. Remember, that you can always get the account ID and other user details by User ID.

Create User

POST /users

The method is used to create a new user. This example describes a minimal set of parameters required for this process. For the full set of parameters available for a new user, please refer to Swagger.

Body

Name	Type	Description
email	string	Email of new user
firstName	string	Name of new user
lastName	string	Last name of new user
login	string	Login of new user
password	string	Password for new user
userGroup	integer	ID of the user group to which this user will be assigned
accounts		Section with account details
accountName	string	Name of the account that will be created for this user

Request body

{
  "accounts": [
    {
      "accountName": "Account1223"
    }
  ],
  "email": "[email protected]",
  "firstName": "Name1123",
  "lastName": "Last123",
  "login": "Login1232",
  "password": "12345",
  "userGroup": 570789
}

CURL

curl -X POST "http://sandbox.traderevolution.com:8443/proftrading/rest/users" -H "accept: application/json" -H "Authorization: Bearer eyItMjI2OTkxMTE4Ij...S2wnd2wVKqnE3QypO3xI7LJkLEiuMnd4_epgBqF3z_TRGULkAIAAA.4P7Xssd4FUvIWg2F3Evfd7YGInHwQ-rGfBsBOWbJpPo" -H "Content-Type: application/json" -d "{ \"accounts\": [ { \"accountName\": \"Account1223\" } ], \"email\": \"[email protected]\", \"firstName\": \"Name1123\", \"lastName\": \"Last123\", \"login\": \"Login1232\", \"password\": \"12345\", \"userGroup\": 570789}"

Response

200

{
  "accounts": [
    {
      "id": 680172,
      "name": "Account1223"
    }
  ],
  "id": 1158399,
  "login": "Login1232"
}

As a result, you will get a user ID, login name, account ID, and account name in response. Standard errors can be received as well.

Find user (by login, e-mail, etc.)

GET/users

This method is used to get the names of available users and their IDs. All users can be filtered using various parameters like brandingId, email, userGroupId. The required parameter should be simply specified in the query.

Query

Name	Type	Description
brandingId	string	Branding identifier.
email	string	Filter users by e-mail.
login	string	Filter records by user login. Several logins can be specified using comma separator.
offset	string	Defines the initial index number of outputting records.
planId	string	Identifier of the plan. Any type of plan can be set here (Risk plan, Swap plan, etc.).
userGroupId	string	Identifier of the user group.

CURL example (users are filtered by userGroupId)

curl -X GET "https://sandbox.traderevolution.com:8443/proftrading/rest/users?userGroupId=570789" -H "accept: application/json" -H "Authorization: Bearer eyItMTg5Njc5OTc0OSI6LTE4OTY3OTk3NDksI...UIec_uAAAA.IPtdm_dV1fI1G2tMdJ7CXQSBnGMmZlAG2eMw03ceL0E"

Response

200

[
  {
    "id": 146695,
    "login": "User1"
  },
  {
    "id": 570790,
    "login": "User2"
  }
]

As a result, you will get a user ID and login name of the users assigned to the group specified in the request (ID 570789). Standard errors can be received as well.

A full list of parameters that are available for GET /users can be found here:

https://sandbox.traderevolution.com:8443/proftrading/rest/swagger-ui.html#/Users/getUsersUsingGET

Move user between groups

PATCH /users/{id}

The PATCH method is used to update specific user settings by his ID. This section describes moving users between groups. Transferring a user to another group can be useful in that the user will inherit the trading rules of this group or another scheduler tasks set will be applied to him.

A full list of parameters that are available for PATCH /users can be found here:

https://sandbox.traderevolution.com:8443/proftrading/rest/swagger-ui.html#/Users/patchUserMethodUsingPATCH

Request example

{
  "userGroup": 42495
}

Please note that the request body contains the ID of the user group to which this user will be moved (so in the example our user will be moved to the group whose ID is 42495). The ID of the user, who will be transferred to another group, should be specified in the path, see CURL.

CURL

curl -X PATCH "https://sandbox.traderevolution.com:8443/proftrading/rest/users/570790" -H "accept: application/json" -H "Authorization: Bearer eyItMTg5Njc5OTc0OSI6LTE4OTY3OTk3NDksIjU1NTMzMzU2MiI6NTU1MzMzNTYyLCIxNzg3NzA4MTcxIjoxNzg3NzA4MTcxLCIxNzAyNDYyMjQwIjoxNz...OAefLxUIec_uAAAA.IPtdm_dV1fI1G2tMdJ7CXQSBnGMmZlAG2eMw03ceL0E" -H "Content-Type: application/json" -d "{ \"userGroup\": 42495}"

Response

You will get a 204 message in response. This means that the user is moved successfully.

User status management

PATCH /users/{id}

The PATCH method is used to update specific user settings by his ID. This section describes the updating status of certain users. The following statuses are available: Locked, Unlocked, Locked after brute force, Need activation and Expired.

Path

Name	Type	Description
id	integer	Identifier of the user whose status is changed.

Body

{
  "rules": [
    {
      "ruleName": "STATUS_BLOCKED",
      "ruleValue": "2",
      "restriction": 0,
      "isOverridden": true
    }
  ]
}

CURL

curl -X PATCH "http://sandbox.traderevolution.com:8443/proftrading/rest/users/570790" -H "accept: application/json" -H "Authorization: Bearer eyIyMzI0ODk2MiI6MjMyNDg5NjIsI...NRRxLPsj6F5xX-C9hTN2iVW370Tk" -H "Content-Type: application/json" -d "{ \"rules\": [ { \"ruleName\": \"STATUS_BLOCKED\", \"ruleValue\": \"2\", \"restriction\": 0, \"isOverridden\": true } ]}"

The following values are available for the ruleValue parameter:

• 0 - Unlocked

• 1 - Locked

• 2 - Locked after brute force

• 3 - Need activation

• 4 - Expired

Response

In case the status is changed successfully, you will simply receive the 204 code in the response.

A full list of parameters that are available for PATCH /users can be found here:

https://sandbox.traderevolution.com:8443/proftrading/rest/swagger-ui.html#/Users/patchUserMethodUsingPATCH

Change password

PATCH/users/{id}/changePassword

This API call is used to change passwords. The new password will be updated with the specified value for the user whose ID is added to the request path.

Path

Name	Type	Description
id	string	Identifier of the user for whom the password is changed.

Body

{
  "password": "newpass123",
  "secondPassword": "newpass123",
  "tradingPassword": "12345"
}

CURL

curl -X PATCH "http://sandbox.traderevolution.com:8443/proftrading/rest/users/570790/changePassword" -H "accept: application/json" -H "Authorization: Bearer eyItNzIyNDgyODY5IjotNzIyNDgyODY5LCItNjcyNzUxOTQ5IjotNjcyNzUxOTQ5LCI4NjU2NjY4MTAiOjg2NTY2NjgxMCwiMTI1NDM4MDA0...5tiVOdEu9M7PnRl5Wg1I-zh60-Ir-LnF34x7PHEAQAA.cOEN1WQK2wfcD-I7HggcdbL9rzD963UtTXFWnuIakzY" -H "Content-Type: application/json" -d "{ \"password\": \"newpass123\", \"secondPassword\": \"newpass123\", \"tradingPassword\": \"12345\"}"

Response

You will get a 200 (OK) response in case all the passwords are changed successfully.

A full list of parameters that are available for managing passwords can be found here:

https://sandbox.traderevolution.com:8443/proftrading/rest/swagger-ui.html#/Password_management

Get user groups

GET/userGroups

This method is used to get a list of all user groups available on this server. All groups can be filtered using various parameters like brandingId, name, etc. The required parameter should be simply specified in the query.

Query

Name	Type	Description
brandingId	string	Branding identifier.
name	string	Filter user groups by name.
limit	string	Number of records to retrieve. Default is 1000, maximum is 1000.
offset	string	Defines the initial index number of outputting records.
planId	string	Identifier of the plan. Any type of plan can be set here (Risk plan, Swap plan, etc.).
serverId	string	Identifier of the server (cluster node).

CURL example (all groups are returned, no filtering is applied)

curl -X GET "https://sandbox.traderevolution.com:8443/proftrading/rest/userGroups" -H "accept: application/json" -H "Authorization: Bearer eyItMjQ2NzI5NDUzIjotMjQ2NzI5NDUzLCItMTYzNjE4OTE0OSI6LTE2MzYxODkxNDksIjIwMDk0ODA1NDciOjIwMDk0ODA1NDcsIi0xODQzMD...dju7Z6ThRVSvXnrjoAY0pRkBiGq3SK0xLH4pSuAyBT1WxpbXzWLVtG_0SVlq2bANufLxtVFFatRS3s-P1XIC-cL3HlKZBsAQAA.5AHDn_Ohw52zPaHKr8l9H0kx6HWv1sh_1IvOJ5DDpHE"

Response

200

[
  {
    "userGroupId": -10,
    "userGroupName": "Root"
  },
  {
    "userGroupId": 0,
    "userGroupName": "Default Trader"
  },
  {
    "userGroupId": 2,
    "userGroupName": "Default Dealer"
  },
  {
    "userGroupId": 13340,
    "userGroupName": "PFS_Exchange"
  },
  {
    "userGroupId": 831168,
    "userGroupName": "TEST"
  }
]

A full list of parameters that are available for /userGroups can be found here:

https://sandbox.traderevolution.com:8443/proftrading/rest/swagger-ui.html#/User_groups

Trading Webhooks

The Trading Webhooks keys methods allows generating and managing API keys used for trading via webhooks. These keys are used for authentication when sending webhook requests to the TE server.

An authorized user can generate, retrieve, and remove webhook keys only for their own account.

Generate Webhooks keys

POST /webhookskeys

This method is used to generate a new webhook API and secret keys. The request may include an optional key name. If the name is not provided, the system will generate one automatically.

Body parameter

Name	Type	Description
name	string/body	Optional name of the webhook key. Maximum length is 32 characters.

Request body

{
  "name": "webhook-key-1"
}

Response

200

{
  "webhookskeyId": 145,
  "apiKey": "GaBvC…yxvpgIHfXCbpiU8",
  "key": "316…578",
  "createdDate": 1714780800000,
  "expiredDate": 1717382800000,
  "name": "webhook-key-1"
}

Get Webhooks keys

GET/webhooksKeys

This method returns a list of webhook keys generated by the authorized user. The response contains all keys created by the user, except the secret key value.

Response

200

[
  {
    "webhookskeyId": 145,
    "apiKey": "GaBvCWdwsyTx…aZyxvpgIHfXCbpiU8",
    "createdDate": 1714780800000,
    "expiredDate": 1717382800000,
    "name": "webhook-key-1"
  },
  {
    "webhookskeyId": 146,
    "apiKey": "n7cYjP2sdFv5…3Xc9RtDqWbU",
    "createdDate": 1714800000000,
    "expiredDate": null,
    "name": "webhook-key-2"
  }
]

In the response an array with keys and additional information is sent.

Delete Webhooks keys

DELETE/webhooksKeys/{webhookskeyId}

This method allows removing webhook keys. Webhook key ID that need to be deleted must be specified in the path parameters.

Path parameter

Name	Type	Description
webhookskeyId	integer/path	Unique identifier of the webhook key.

In the response the 200 OK status will be sent if the webhook key was deleted successfully.