Get groups list

GetGroups

Description: Returns the list of trading groups available to the current manager session. The result is filtered by the current cached manager access scope: access_backoffice, see_accounts / see_trades / market_watch, groups, and brand. Token payload is used only to resolve the manager id and session type.

Request Parameters

No parameters required.

Access Scope

• SESSION_ADMIN or managers with admin = 1 can see all groups.
• Non-admin sessions must have access_backoffice = 1.
• groups limits returned group names by wildcard mask.
• brand limits returned groups to the manager's brand when it is set.

Response Parameters

Name	Type	Description
rows	array	List of group configuration objects
count	int	Number of returned groups

Each object in rows contains:

Field	Type	Description
group	string	Group name
brand	string	Brand namespace for accounts in this trading group
account_mode	int	Account mode for self-service opening: 0 = DEMO, 1 = REAL
public_opening	int	Customer self-service opening flag
currency	string	Group base currency
grp_index	int	Internal group index
enable	int	Group enabled flag
timeout	int	Timeout setting
default_leverage	int	Default leverage
default_deposit	double	Default deposit
credit	double	Credit value
margin_call	int	Margin call level
margin_mode	int	Margin mode
interestrate	int	Interest rate
hedge_largeleg	int	Hedge large leg mode
margin_stopout	int	Margin stop-out level
margin_call_recovery_buffer	double	Recovery buffer above margin_call; percentage points for percent margin, account currency for currency margin
margin_stopout_recovery_buffer	double	Recovery buffer above margin_stopout; percentage points for percent margin, account currency for currency margin
margin_recovery_hold_ms	int	Continuous recovery hold time in milliseconds
use_swap	int	Swap enabled flag
maxpositions	int	Max positions
hedge_prohibited	int	Hedge prohibited flag
allow_negative_margin_hedge	int	Negative free-margin opening policy: 1 allows operations that do not worsen projected free margin; 0 rejects opening while current free margin is negative
partial_close	int	Partial close permission
allow_sl_tp_slippage	int	SL/TP slippage permission: 1 = close by current market price after trigger, 0 = close exactly at SL/TP level
margin_type	int	Margin type
stopout_skip_hedged	int	Skip stop-out for hedged positions
archive_pending_period	int	Archive period for pending orders
close_reopen	int	Close/reopen flag
secgroups	array	Security-group overrides
secmargins	array	Symbol-level margin overrides

secgroups items may contain: - sec_index - show - trade - execution - comm_base - comm_type - comm_lots - comm_tax - comm_agent - comm_agent_type - comm_agent_lots - spread_diff - lot_min - lot_max - lot_step - confirmation - trade_rights - autocloseout_mode - name - description - background_color

secmargins items may contain: - symbol - swap_enable - swap_long - swap_short - margin_divider - spread_enable - spread - spread_balance

Response Example

{
  "rows": [
    {
      "group": "standard",
      "brand": "ion4",
      "account_mode": 1,
      "public_opening": 0,
      "currency": "USD",
      "grp_index": 1,
      "enable": 1,
      "timeout": 0,
      "default_leverage": 100,
      "default_deposit": 500.0,
      "credit": 0.0,
      "margin_call": 50,
      "margin_mode": 0,
      "margin_stopout": 30,
      "margin_call_recovery_buffer": 5.0,
      "margin_stopout_recovery_buffer": 5.0,
      "margin_recovery_hold_ms": 3000,
      "margin_type": 0,
      "allow_negative_margin_hedge": 1,
      "partial_close": 1,
      "allow_sl_tp_slippage": 1,
      "secgroups": [
        {
          "sec_index": 1,
          "show": 1,
          "trade": 1,
          "execution": 0,
          "name": "FX",
          "description": "Forex Instruments",
          "background_color": "#ffffff"
        }
      ],
      "secmargins": [
        {
          "symbol": "EURUSD",
          "swap_long": -3.5,
          "swap_short": 2.1,
          "margin_divider": 1.0
        }
      ]
    }
  ],
  "count": 1
}