Skip to content

Update group

UpdateGroup

Description: Creates a new group or updates an existing trading group with full configuration of trading parameters, security mappings, and symbol-specific margin overrides.

Request Parameters

Name Type Required Description
group string Yes Unique name of the group
company string Yes Company or broker name
currency string Yes Base currency of the group (e.g., "USD")
enable int Yes Enable status: 1 for active, 0 for disabled
margin_call int Yes Margin call level (percent)
margin_stopout int Yes Stop-out level (percent)
margin_mode int Yes Margin calculation mode
margin_type int Yes Margin type (e.g., netting/hedging)
default_leverage int Yes Default leverage value
default_deposit double Yes Default deposit for new users in this group
credit double No Credit amount
use_swap int No 1 to use swap, 0 to disable
hedge_prohibited int No 1 if hedging is prohibited
stopout_skip_hedged int No Skip stop-out on hedged positions
close_reopen int No 1 if close & reopen is allowed
interestrate int No Interest rate (%)
hedge_largeleg int No Hedge large leg strategy
archive_pending_period int No Time (in seconds) before archiving pending orders
maxpositions int No Maximum number of positions allowed
secgroups array Yes Array of security settings by sec_index
secmargins array Yes Margin overrides per symbol

secgroups Object Fields

Field Type Description
sec_index int Security group index
show int 1 to display this group
trade int 1 to allow trading
execution int Execution mode
comm_base double Base commission
comm_type int Commission type
comm_lots int Commission per lots
comm_tax double Tax applied
comm_agent int/double Agent commission
comm_agent_type int Agent commission type
comm_agent_lots int Agent commission per lots
spread_diff int Spread difference adjustment
lot_min int Minimum lot size
lot_max int Maximum lot size
lot_step int Lot step size
confirmation int Confirmation flag
trade_rights int Trade permissions
autocloseout_mode int Auto-closeout behavior
name string Security group name
description string Description

secmargins Object Fields

Field Type Description
symbol string Symbol name (e.g., "EURUSD")
swap_long double Long swap value
swap_short double Short swap value
margin_divider double Margin divider for this symbol

Request Example

{
  "group": "standard",
  "company": "MyBroker",
  "currency": "USD",
  "enable": 1,
  "margin_call": 50,
  "margin_stopout": 30,
  "margin_mode": 0,
  "margin_type": 0,
  "default_leverage": 100,
  "default_deposit": 500.0,
  "secgroups": [
    {
      "sec_index": 1,
      "show": 1,
      "trade": 1,
      "execution": 0,
      "comm_base": 0.0,
      "comm_type": 0,
      "comm_lots": 1,
      "comm_tax": 0.0,
      "lot_min": 100,
      "lot_max": 100000,
      "lot_step": 100,
      "name": "FX",
      "description": "Forex Instruments"
    }
  ],
  "secmargins": [
    {
      "symbol": "EURUSD",
      "swap_long": -3.5,
      "swap_short": 2.1,
      "margin_divider": 1.0
    }
  ]
}

Response Parameters

Name Type Description
data string Returns "OK" on success

Response Example

{
  "data": "OK"
}