Get symbols summary
GetSymbolsSummary¶
Description:
Returns a summarized view of trading activity across all symbols, including total buy/sell lots, prices, profit and covered trades. Can be filtered by user group using groupFilter.
Access Control¶
🛡️ Access Level Required:
SESSION_USER,SESSION_MANAGER,SESSION_ADMIN,SESSION_DEALER
Endpoint¶
This method is routed internally as GetSymbolsSummary.
Optional Request Parameters¶
| Name | Type | Required | Description |
|---|---|---|---|
| groupFilter | string | No | Filter trades by user group. Default: "*" |
Response Structure¶
| Field | Description |
|---|---|
| symbol | Trading symbol (e.g., EURUSD) |
| type | Trade type identifier |
| orders | Number of open orders |
| buylots | Total buy lots |
| selllots | Total sell lots |
| buyprice | Aggregated average buy price |
| sellprice | Aggregated average sell price |
| profit | Total profit |
| covorders | Covered orders count |
| covbuylots | Covered buy lots |
| covselllots | Covered sell lots |
| covbuyprice | Covered average buy price |
| covsellprice | Covered average sell price |
| covprofit | Covered profit |
Response Example¶
{
"structure": [
"symbol", "type", "orders", "buylots", "selllots", "buyprice", "sellprice", "profit",
"covorders", "covbuylots", "covselllots", "covbuyprice", "covsellprice", "covprofit"
],
"rows": [
[
"EURUSD", 0, 12, 25.0, 23.0, 1.1023, 1.1027, 240.5,
10, 20.0, 20.0, 1.1020, 1.1028, 180.0
]
],
"count": 1
}
Error Example¶
{
"error": "INVALID_DATA",
"message": "groupFilter is not valid"
}