Add symbols group
AddSymbolGroup¶
Description:
Creates a new symbol group (security group) used to organize and manage trading instruments within the trading platform. This is useful for hierarchical display, filtering, or enabling/disabling access to certain market segments.
Access Control¶
🛡️ Access Level Required:
SESSION_ADMIN,SESSION_MANAGER,SESSION_DEALER
Endpoint¶
This method is routed internally as AddSymbolGroup.
Request Parameters¶
| Name | Type | Required | Description |
|---|---|---|---|
| trade | int | Yes | Indicates if the group is tradable (1 = enabled, 0 = disabled) |
| show | int | Yes | Indicates if the group should be visible (1 = visible, 0 = hidden) |
| parent_sec_index | int | No | Optional parent security index for nested grouping |
| name | string | Yes | Name of the symbol group (1–64 characters) |
| description | string | Yes | Description of the group (up to 256 characters) |
Request Example¶
{
"trade": 1,
"show": 1,
"parent_sec_index": 10,
"name": "Commodities",
"description": "Group for all energy and metal trading instruments"
}
Response Example¶
{
"sec_index": 101,
"data": "OK"
}
sec_index: Unique security index assigned to the new symbol group.
Error Responses¶
Validation Error¶
{
"error": "INVALID_DATA",
"message": "name is required"
}
Internal Error¶
{
"error": "Add_SECURITIES_ERROR"
}