Calculated Fields

Calculated fields are special computed values available in the Groups endpoint. These fields are calculated in real-time and provide powerful insights into your data.

Available Calculated Fields

accountsCount

The number of accounts assigned to a group.

symbolsCount

The number of symbols configured for a group.

positionsCount

The number of open positions for accounts in the group.

Supported Operations

All calculated fields support these operations:

Operation	Syntax	Description	Example
eq	field__eq=value	Exact count	accountsCount__eq=5
ne	field__ne=value	Not equal count	symbolsCount__ne=0
gt	field__gt=value	More than count	accountsCount__gt=10
ge	field__ge=value	At least count	symbolsCount__ge=1
lt	field__lt=value	Less than count	positionsCount__lt=100
le	field__le=value	At most count	accountsCount__le=20

Examples

Find Active Groups

# Groups with at least one account
GET /api/v0/groups?accountsCount__ge=1

# Groups with configured symbols
GET /api/v0/groups?symbolsCount__gt=0

# Groups with active positions
GET /api/v0/groups?positionsCount__gt=0

Find Empty Groups

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

# Groups with no symbols configured
GET /api/v0/groups?symbolsCount__eq=0

Range Filtering

# Medium-sized groups (5-50 accounts)
GET /api/v0/groups?accountsCount__ge=5&accountsCount__le=50

# Groups with moderate trading activity
GET /api/v0/groups?positionsCount__ge=1&positionsCount__le=100

Complex Queries

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

# Groups that need attention (accounts but no symbols)
GET /api/v0/groups?accountsCount__gt=0&symbolsCount__eq=0

Performance Notes

⚠️ Hybrid Processing: Calculated fields use a hybrid approach:

1. Regular database filtering is applied first

2. Calculated field filtering happens in memory

3. Results are then paginated

💡 Best Practice: For better performance, combine calculated field filters with regular field filters:

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

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

Sorting

You can also sort by calculated fields:

# Sort by number of accounts (descending)
GET /api/v0/groups?sort=accountsCount&order=DESC

# Sort by symbol count (ascending)  
GET /api/v0/groups?sort=symbolsCount&order=ASC

# Sort by positions count
GET /api/v0/groups?sort=positionsCount&order=DESC

Next Steps

• Learn about Field Types for detailed type information

• Check out Usage Examples for more practical implementations