Skip to main content
POST
/
groups
Create Group
curl --request POST \
  --url https://api.{your-broker}.slate-labs.com/groups \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "currency": "USD",
  "default_leverage": 100,
  "margin_call_level": 50,
  "stopout_level": 20,
  "commission_type": "none",
  "commission_value": 0,
  "swap_free": false,
  "swap_enabled": true,
  "swap_multiplier": 1,
  "swap_free_days": 0,
  "is_islamic": false,
  "max_exposure": 1,
  "net_max_exposure": false,
  "max_open_positions": 200,
  "is_default": false,
  "is_active": true
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "currency": "<string>",
  "default_leverage": 123,
  "margin_call_level": 123,
  "stopout_level": 123,
  "commission_type": "<string>",
  "commission_value": 123,
  "swap_free": true,
  "is_islamic": true,
  "max_exposure": 123,
  "net_max_exposure": true,
  "is_default": true,
  "is_active": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "swap_enabled": true,
  "swap_multiplier": 1,
  "swap_free_days": 0,
  "max_open_positions": 200
}

Body

application/json
name
string
required
Required string length: 1 - 64
currency
string
default:USD
Maximum string length: 8
default_leverage
integer
default:100
Required range: 1 <= x <= 1000
margin_call_level
number
default:50
Required range: 20 <= x <= 95
stopout_level
number
default:20
Required range: 5 <= x <= 80
commission_type
string
default:none
commission_value
number
default:0
Required range: 0 <= x <= 50
swap_free
boolean
default:false
swap_enabled
boolean
default:true
swap_multiplier
number
default:1
Required range: 0.01 <= x <= 10
swap_free_days
integer
default:0
Required range: 0 <= x <= 365
is_islamic
boolean
default:false
max_exposure
number | null
Required range: x >= 0
net_max_exposure
boolean
default:false
max_open_positions
integer | null
default:200
Required range: 1 <= x <= 10000
is_default
boolean
default:false
is_active
boolean
default:true

Response

Successful Response

id
string<uuid>
required
name
string
required
currency
string
required
default_leverage
integer
required
margin_call_level
number
required
stopout_level
number
required
commission_type
string
required
commission_value
number
required
swap_free
boolean
required
is_islamic
boolean
required
max_exposure
number | null
required
net_max_exposure
boolean
required
is_default
boolean
required
is_active
boolean
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
swap_enabled
boolean
default:true
swap_multiplier
number
default:1
swap_free_days
integer
default:0
max_open_positions
integer | null
default:200