Get groups list

GetGroups

Description: Returns the list of trading groups available to the current manager session. The result is additionally filtered by the manager's allowed groups mask.

Request Parameters

No parameters required.

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
company	string	Company name
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
use_swap	int	Swap enabled flag
maxpositions	int	Max positions
hedge_prohibited	int	Hedge prohibited flag
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

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

Response Example

{
  "rows": [
    {
      "group": "standard",
      "company": "MyBroker",
      "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_type": 0,
      "secgroups": [
        {
          "sec_index": 1,
          "show": 1,
          "trade": 1,
          "execution": 0,
          "name": "FX",
          "description": "Forex Instruments"
        }
      ],
      "secmargins": [
        {
          "symbol": "EURUSD",
          "swap_long": -3.5,
          "swap_short": 2.1,
          "margin_divider": 1.0
        }
      ]
    }
  ],
  "count": 1
}