Accounts Endpoint

The Accounts endpoint is the most commonly used endpoint in the system, providing comprehensive user account management and filtering capabilities.

Endpoint Information

• URL: GET /api/v0/accounts

• Authentication: Required

• Permissions: SUPER_ADMIN or Account_getAll

Searchable Fields

Field	Type	Description	Example
id	Long	Account ID	id=123
number	Long	Account number	number=10001
fullName	String	Account holder's full name	fullName__like=john
group.name	String	Group name (nested)	group.name=VIP
balance	BigDecimal	Account balance	balance__ge=1000
credit	BigDecimal	Account credit	credit__gt=0
margin	BigDecimal	Used margin	margin__le=500
marginFree	BigDecimal	Free margin	marginFree__gt=1000
equity	BigDecimal	Account equity	equity__ge=5000
floating	BigDecimal	Floating profit/loss	floating__ne=0
createdAt	Date	Creation date	createdAt__ge=2024-01-01
updatedAt	Date	Last update date	updatedAt__le=2024-12-31

Common Use Cases

Find Active Accounts

# Accounts with positive balance
GET /api/v0/accounts?balance__gt=0

# Accounts with trading activity (floating P&L)
GET /api/v0/accounts?floating__ne=0

# Recently updated accounts
GET /api/v0/accounts?updatedAt__ge=2024-08-01

Financial Filtering

# High-value accounts
GET /api/v0/accounts?equity__ge=10000

# Accounts with margin usage
GET /api/v0/accounts?margin__gt=0

# Accounts with available credit
GET /api/v0/accounts?credit__gt=0&marginFree__gt=500

Group-based Filtering

# VIP group members
GET /api/v0/accounts?group.name=VIP

# Multiple groups
GET /api/v0/accounts?group.name__in=VIP,Premium,Gold

# Exclude demo accounts
GET /api/v0/accounts?group.name__ne=Demo

Search by Name

# Search for specific name
GET /api/v0/accounts?fullName__like=john

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

Range Filtering

# Medium balance accounts
GET /api/v0/accounts?balance__ge=1000&balance__le=10000

# Accounts created this year
GET /api/v0/accounts?createdAt__ge=2024-01-01&createdAt__le=2024-12-31

# Specific account number range
GET /api/v0/accounts?number__ge=10000&number__lt=20000

Pagination & Sorting

Common Sorting Options

# Sort by balance (highest first)
GET /api/v0/accounts?sort=balance&order=DESC

# Sort by name alphabetically
GET /api/v0/accounts?sort=fullName&order=ASC

# Sort by creation date (newest first)
GET /api/v0/accounts?sort=createdAt&order=DESC

# Sort by account number
GET /api/v0/accounts?sort=number&order=ASC

Pagination Examples

# First page, 20 items
GET /api/v0/accounts?page=0&size=20

# Second page, 50 items
GET /api/v0/accounts?page=1&size=50

# Large page size for exports
GET /api/v0/accounts?page=0&size=1000

Complex Queries

Business Intelligence

# High-value active traders
GET /api/v0/accounts?equity__ge=50000&floating__ne=0&group.name__ne=Demo

# Accounts needing attention (low free margin)
GET /api/v0/accounts?balance__gt=0&marginFree__lt=100

# New accounts this month
GET /api/v0/accounts?createdAt__ge=2024-08-01&group.name__ne=Demo

Risk Management

# Accounts with high margin usage
GET /api/v0/accounts?margin__gt=1000&marginFree__lt=500

# Accounts with negative floating
GET /api/v0/accounts?floating__lt=0&balance__gt=0

# Large accounts for monitoring
GET /api/v0/accounts?equity__ge=100000&sort=equity&order=DESC

Response Example

{
  "message": "Data fetched successfully",
  "data": [
    {
      "id": 1,
      "number": 10001,
      "fullName": "John Smith",
      "groupName": "VIP",
      "balance": 5000.00,
      "credit": 1000.00,
      "margin": 250.50,
      "marginFree": 4749.50,
      "equity": 5150.75,
      "floating": 150.75,
      "createdAt": "2024-01-15T10:30:00",
      "updatedAt": "2024-08-19T14:22:15"
    }
  ],
  "currentPage": 0,
  "totalItems": 1523,
  "totalPages": 77
}