Get groups list

GetGroups¶

Description: Retrieves a full list of user trading groups along with their trading rules, settings, security mappings, and margin parameters.

Request Parameters¶

No parameters required.

Response Parameters¶

Name	Type	Description
rows	array	Array of group configuration objects
count	int	Total number of groups returned

Each object in rows contains fields such as:

group
currency
company
enable
timeout
default_leverage
default_deposit
credit
margin_call
margin_mode
interestrate
hedge_largeleg
margin_stopout
use_swap
maxpositions
hedge_prohibited
margin_type
stopout_skip_hedged
archive_pending_period
close_reopen

As well as:

secgroups: array of security configurations per group
secmargins: array of symbol-level margin overrides

Response Example (truncated)¶

{
  "rows": [
    {
      "group": "standard",
      "currency": "USD",
      "company": "MyBroker Ltd.",
      "enable": 1,
      "timeout": 300,
      "default_leverage": 100,
      "default_deposit": 500.0,
      "credit": 0.0,
      "margin_call": 50,
      "margin_mode": 0,
      "secgroups": [
        {
          "sec_index": 1,
          "show": 1,
          "trade": 1,
          "execution": 0,
          "comm_base": 0.0,
          "comm_type": 0,
          "name": "Forex",
          "description": "Forex Securities"
        }
      ],
      "secmargins": [
        {
          "symbol": "EURUSD",
          "swap_long": -3.5,
          "swap_short": 2.1,
          "margin_divider": 1.0
        }
      ]
    }
  ],
  "count": 1
}