Get symbols group list
GetSymbolGroups¶
Description:
Returns a list of all symbol groups (security groups), including their visibility, trading status, hierarchy, and display order.
Access Control¶
🛡️ Access Level Required:
SESSION_USER,SESSION_MANAGER,SESSION_ADMIN,SESSION_DEALER
Endpoint¶
This method is routed internally as GetSymbolGroups.
Response Parameters¶
Each object in the rows array contains:
| Field | Type | Description |
|---|---|---|
| sec_index | int | Unique ID of the symbol group |
| sort_index | int | Optional sorting order index |
| trade | int | Indicates if trading is allowed for this group (1 = yes, 0 = no) |
| show | int | Indicates if the group is visible (1 = yes, 0 = no) |
| parent_sec_index | int | ID of the parent group (for hierarchy) |
| name | string | Display name of the symbol group |
| description | string | Description of the symbol group |
Response Example¶
{
"rows": [
{
"sec_index": 101,
"sort_index": 1,
"trade": 1,
"show": 1,
"parent_sec_index": 0,
"name": "Commodities",
"description": "Energy and metals instruments"
}
],
"total": 1
}
Error Example¶
{
"error": "INVALID_DATA",
"message": "An internal error occurred"
}