RequestAccountsByQuery
Request a list of accounts by mask
Request format
{
"Search": "446",
"MinEquity": 0,
"Top": "100",
"Book": "BBook",
"RequestId": "d53e2900-96d2-40d9-b7a0-3b95add5280f",
"Nodes": [
"node1",
"node2"
],
"SortFields":["EquityInUsd"],
"SortDirection": "Ascending",
"RequestName": "RequestAccountsByQuery"
}
Request parameters:
| Name | Description | |
|---|---|---|
| RequestId | Unique request GUID | |
| Search | Account filter, works by entering symbols in Account Login, Name, Country, City, Email | |
| MinEquity | Minimum Equity | |
| Top | The number of accounts to display the search result, it is set in text format | |
| Book | Value from [ABook, BBook, NoBook] for which Book to get Exposure | |
| Nodes | List of nodes that participate in the request. If the list is empty, then all available nodes are called. | |
| RequestName | Request type | |
| SortDirection | Specifies the sort direction for the fields specified in "SortFields" (enum ListSortDirection: {Ascending, Descending}) | |
| SortFields | Specifies the fields to sort in the direction specified in "SortDirection" (enum SortableFields: {Node = 0, Login, Group, Name, Email, EquityInUsd, TotalRealizedProfitInUsd, UnrealizedProfitInUsd}) |
The ResponseAccountsByQuery response contains the DtoAccountInfo structure.
{
"Result": [
{
"Name": "Trader",
"EnableReadOnly": false,
"City": "Moscow",
"RegDate": "2017-03-15 17:39:41:000",
"Email": "contact@indigosoft.net",
"Balance": 4998837.8,
"Margin": 23022.87,
"MarginLevel": 21712.75,
"Leverage": 100,
"Drawdown": 0.0,
"NetVolumeInUsd": 459519.85,
"NetVolumeInLots": 9.0,
"Node": "node1",
"Platform": "Mt4",
"Login": 446161,
"Group": "AllgroupTEST",
"Country": "Russia",
"Currency": "USD",
"Equity": 4998899.19,
"ActualLeverage": 0.09,
"EquityInUsd": 4998899.19,
"Lots": 9.0,
"UnrealizedProfitUsd": 61.39,
"UnrealizedProfit": 61.39,
"IsSuspicious": false,
"SuspiciousComment": ""
}
],
"Errors": [],
"RequestId": "d53e2900-96d2-40d9-b7a0-3b95add5280f",
"ResponseMaster": "ResponseAccountsByQuery"
}