Groups Endpoint

The Groups endpoint manages account groups and includes powerful calculated fields for real-time statistics.

Endpoint Information

• URL: GET /api/v0/groups

• Authentication: Required

• Permissions: SUPER_ADMIN or Group_getAll

Searchable Fields

Regular Fields

Field	Type	Description	Example
id	Long	Group ID	id=1
name	String	Group name	name__like=trading
description	String	Group description	description__like=vip
currency.name	String	Currency name (nested)	currency.name=USD
stopOutLevel	Integer	Stop out percentage	stopOutLevel__ge=50
marginCallLevel	Integer	Margin call percentage	marginCallLevel__le=100
limitPositions	Integer	Max positions allowed	limitPositions__gt=10
limitPending	Integer	Max pending orders	limitPending__ge=5
createdAt	Date	Creation date	createdAt__ge=2024-01-01
updatedAt	Date	Last update date	updatedAt__le=2024-12-31

Calculated Fields (Real-time)

Field	Type	Description	Example
accountsCount	Long	Number of accounts in group	accountsCount__gt=10
symbolsCount	Long	Number of symbols configured	symbolsCount__ge=5
positionsCount	Long	Number of open positions	positionsCount__gt=0

Common Use Cases

Find Active Groups

# Groups with accounts
GET /api/v0/groups?accountsCount__gt=0

# Groups with trading activity
GET /api/v0/groups?positionsCount__gt=0

# Well-configured groups
GET /api/v0/groups?accountsCount__ge=5&symbolsCount__ge=10

Group Analysis

# Large groups (50+ accounts)
GET /api/v0/groups?accountsCount__ge=50

# Groups needing symbol configuration
GET /api/v0/groups?accountsCount__gt=0&symbolsCount__eq=0

# High-activity groups
GET /api/v0/groups?positionsCount__ge=100

Risk Management Settings

# Conservative groups (high stop out)
GET /api/v0/groups?stopOutLevel__ge=80

# High-limit groups
GET /api/v0/groups?limitPositions__ge=100

# USD-based groups
GET /api/v0/groups?currency.name=USD

Calculated Fields Performance

⚠️ Performance Note: Calculated fields use hybrid processing:

1. Database filters regular fields first

2. Calculated fields processed in memory

3. Best practice: Combine with regular field filters

# Good: Filter by name first, then calculated field
GET /api/v0/groups?name__like=trading&accountsCount__gt=10

# Less optimal: Only calculated field
GET /api/v0/groups?accountsCount__gt=10

Complex Queries

Business Intelligence

# Active trading groups
GET /api/v0/groups?accountsCount__ge=10&symbolsCount__ge=5&positionsCount__gt=0

# Groups with unused capacity
GET /api/v0/groups?accountsCount__lt=limitPositions&symbolsCount__gt=10

# Popular groups this year
GET /api/v0/groups?createdAt__ge=2024-01-01&accountsCount__ge=20

Administrative Insights

# Empty groups for cleanup
GET /api/v0/groups?accountsCount__eq=0&symbolsCount__eq=0

# Groups exceeding limits
GET /api/v0/groups?positionsCount__ge=limitPositions

# Recently created active groups
GET /api/v0/groups?createdAt__ge=2024-08-01&accountsCount__gt=0

Sorting Options

Sort by Calculated Fields

# Most popular groups
GET /api/v0/groups?sort=accountsCount&order=DESC

# Most active trading
GET /api/v0/groups?sort=positionsCount&order=DESC

# Best configured groups
GET /api/v0/groups?sort=symbolsCount&order=DESC

Sort by Regular Fields

# Alphabetical by name
GET /api/v0/groups?sort=name&order=ASC

# Newest groups first
GET /api/v0/groups?sort=createdAt&order=DESC

# Most restrictive (highest stop out)
GET /api/v0/groups?sort=stopOutLevel&order=DESC