Field Types

Understanding which operations work with different data types is crucial for building effective search queries. This section explains the supported field types and their compatible operations.

Numeric Types

Supported Types

• Integer

• Long

• Float

• Double

• BigDecimal

Compatible Operations

• eq, ne, gt, ge, lt, le, in

Examples

# Balance filtering
GET /api/v0/accounts?balance__gt=1000
GET /api/v0/accounts?balance__ge=500&balance__le=5000

# Multiple leverage values
GET /api/v0/accounts?leverage__in=1,10,50,100

# Exact margin value
GET /api/v0/accounts?margin__eq=250.50

String Types

Supported Types

• String

Compatible Operations

• eq, ne, gt, ge, lt, le, like, in

Examples

# Exact name match
GET /api/v0/accounts?name=John

# Name contains (case-insensitive)
GET /api/v0/accounts?name__like=admin

# Multiple status values
GET /api/v0/accounts?status__in=active,pending

# Alphabetical comparison
GET /api/v0/accounts?name__gt=M

Special Notes

• like operation is case-insensitive

• gt, ge, lt, le perform alphabetical comparison

• String comparisons are useful for alphabetical sorting/filtering

Date/Time Types

Supported Types

• Date

• LocalDate

• LocalDateTime

• Timestamp

Compatible Operations

• eq, ne, gt, ge, lt, le, in

Date Formats

• Date: yyyy-MM-dd (e.g., 2024-01-01)

• DateTime: ISO format (e.g., 2024-01-01T10:30:00)

Examples

# Accounts created after a date
GET /api/v0/accounts?createdAt__ge=2024-01-01

# Positions opened today
GET /api/v0/trade/positions?openTime__ge=2024-08-19

# Date range filtering
GET /api/v0/trade/histories?closeTime__ge=2024-01-01&closeTime__le=2024-12-31

# Multiple specific dates
GET /api/v0/accounts?createdAt__in=2024-01-01,2024-06-01,2024-12-01

Boolean Types

Supported Types

• Boolean

Compatible Operations

• eq, ne, in

Values

• true

• false

Examples

# Enabled accounts only
GET /api/v0/accounts?enabled=true

# Disabled accounts
GET /api/v0/accounts?enabled__ne=true

# Mixed boolean values
GET /api/v0/accounts?swap__in=true,false

Enum Types

Supported Types

Custom enums such as:

• TradeDirection (BUY, SELL)

• AccountFundTypes (Balance, Credit)

• PendingHistoryReasons

Compatible Operations

• eq, ne, in

Examples

# Buy positions only
GET /api/v0/trade/positions?direction=BUY

# Exclude sell positions
GET /api/v0/trade/positions?direction__ne=SELL

# Multiple directions
GET /api/v0/trade/positions?direction__in=BUY,SELL

# Balance operations only
GET /api/v0/account-funds?type=Balance

Calculated Fields (Groups Only)

Supported Types

• Long (count values)

Available Fields

• accountsCount

• symbolsCount

• positionsCount

Compatible Operations

• eq, ne, gt, ge, lt, le

Examples

# Groups with more than 10 accounts
GET /api/v0/groups?accountsCount__gt=10

# Groups with exactly 5 symbols
GET /api/v0/groups?symbolsCount__eq=5

# Active groups (with positions)
GET /api/v0/groups?positionsCount__ge=1

Nested Field Access

You can search within related entities using dot notation:

Examples

# Accounts in specific group
GET /api/v0/accounts?group.name=VIP

# Positions for specific account
GET /api/v0/trade/positions?account.number=12345

# Groups using specific currency
GET /api/v0/groups?currency.name=USD

# Symbols in specific category
GET /api/v0/symbols?category.name=Forex

Operation Compatibility Matrix

Type	eq	ne	gt	ge	lt	le	like	in
Numeric	✅	✅	✅	✅	✅	✅	❌	✅
String	✅	✅	✅	✅	✅	✅	✅	✅
Date/Time	✅	✅	✅	✅	✅	✅	❌	✅
Boolean	✅	✅	❌	❌	❌	❌	❌	✅
Enum	✅	✅	❌	❌	❌	❌	❌	✅
Calculated	✅	✅	✅	✅	✅	✅	❌	❌

Next Steps

• Explore API Endpoints to see which fields are available for each endpoint

• Check out Usage Examples for practical implementations