List accounts with optional field selection and nested objects

Returns paginated accounts with optional field selection through query. Callers can request account fields, user and phase objects, position counts, and up to 10 recent closed positions per account. status filters accounts and defaults to ACTIVE; use all to disable that filter. position_counts_closed_at_after and position_counts_closed_at_before limit only the position count fields, not the returned accounts. Staff users see accessible firm accounts; regular users see only their own.

GET /api/accounts/summary/

List accounts with optional field selection and nested objects

cURL

curl --request GET \
  --url https://api.example.com/api/accounts/summary/ \
  --header 'Authorization: <api-key>'

200

ThreeFieldsOnly

{
  "meta": {
    "count": 123,
    "page": 1,
    "page_size": 20,
    "total_pages": 7,
    "has_next": true,
    "has_previous": false,
    "next": "https://api.example.org/resources/?page=2",
    "previous": null
  },
  "results": [
    {
      "account_id": 101,
      "balance": 50000,
      "equity": 52500.5
    }
  ]
}

Authorizations

Authorization · string · header · required

Token-based authentication with required prefix "Token"

Query Parameters

broker_type · enum<string>

Filter accounts by broker type. Accepts a single value or a comma-separated list of values. Multiple values are treated as a union (return rows matching any of them).

Available options: ALL, Ctrader, MatchTrade, MetaTrader, MetaTrader5, Sim2Funded, Tickblaze, TickblazeOMS, TradeLocker, Tradovate, Volumetrica

created_after · string<date-time>

Return only accounts created at or after this ISO 8601 datetime. Combine *_after and *_before to define a window. The maximum window span is 31 days when both bounds are set.

created_before · string<date-time>

Return only accounts created at or before this ISO 8601 datetime. Combine *_after and *_before to define a window. The maximum window span is 31 days when both bounds are set.

disabled_at_after · string<date-time>

Return only accounts whose disabled timestamp is at or after this ISO 8601 datetime. Combine *_after and *_before to define a window. The maximum window span is 31 days when both bounds are set.

disabled_at_before · string<date-time>

Return only accounts whose disabled timestamp is at or before this ISO 8601 datetime. Combine *_after and *_before to define a window. The maximum window span is 31 days when both bounds are set.

modified_after · string<date-time>

Return only accounts last modified at or after this ISO 8601 datetime. Useful for incremental syncs. Combine *_after and *_before to define a window. The maximum window span is 31 days when both bounds are set.

modified_before · string<date-time>

Return only accounts last modified at or before this ISO 8601 datetime. Combine *_after and *_before to define a window. The maximum window span is 31 days when both bounds are set.

page · integer

1-indexed page number. Defaults to 1.

page_size · integer

Rows per page. Defaults to 20, max 100.

payout_frequency · enum<string>

Filter accounts by payout frequency. Accepts a single value or a comma-separated list of values. Multiple values are treated as a union (return rows matching any of them).

Available options: BI-WEEKLY, DAILY, EVERY 10 DAYS, EVERY 21 DAYS, EVERY 28 DAYS, EVERY 3 DAYS, EVERY 5 DAYS, MONTHLY, TRIPLE PAYOUT, WEEKLY

position_counts_closed_at_after · string<date-time>

Scope long_positions_count and short_positions_count to closed positions with close timestamps at or after this ISO 8601 datetime. This changes only those count fields; it does not change which accounts are returned. Counts are all-time when this and position_counts_closed_at_before are omitted.

position_counts_closed_at_before · string<date-time>

Scope long_positions_count and short_positions_count to closed positions with close timestamps at or before this ISO 8601 datetime. This count window is inclusive and based on closed-position close time.

query · string

Choose which fields you want in the response.

Pass a brace-delimited list of the fields you want. The response includes exactly those fields, in the shape you request — useful for trimming large responses to just what your report needs, and for expanding related objects (user, firm, positions) inline so you don't need follow-up calls.

Syntax:

• Flat field list: ?query={account_id, balance, equity}
• Nested object: ?query={account_id, user{id, email}}
• Multiple nested objects: ?query={account_id, user{id}, phase{id, title}}

Nesting limit: 2 levels deep. Requests nested deeper are rejected with HTTP 400. The outermost {...} counts as level 1; each field{...} inside adds a level.

Behavior when omitted: the response includes every field documented in the 200 response schema. For best performance, pass ?query= explicitly and ask for only the fields you need — some fields (counts, lists of related objects) are skipped from the response cost when not requested.

source · enum<string>

Filter accounts by their creation source. Accepts a single value or a comma-separated list of values. Multiple values are treated as a union (return rows matching any of them).

Available options: ADMIN_MANUAL_CREATE, ADMIN_VERIFICATION, DATA_IMPORT, WEBHOOK

status · string

Filter accounts by status. Accepts any AccountStatusChoices value (e.g. ACTIVE, FAILED, BLOCKED) or the literal all to disable filtering. Defaults to ACTIVE when omitted.

status_reason · enum<string>

Filter accounts by status reason. Useful in combination with status=FAILED to detect specific failure modes (e.g. soft breaches). Accepts a single value or a comma-separated list of values. Multiple values are treated as a union (return rows matching any of them).

Available options: ACCOUNT_EXPIRED, CHALLENGE_RESET, COPY_TRADING_DETECTED, DAILY_DRAWDOWN_EXCEEDED, FLOATING_PNL_EXCEEDED, MAX_DRAWDOWN_EXCEEDED, PROFIT_TARGET_REACHED, RULE_BREACHED, SUBSCRIPTION_EXPIRED, TRADING_STRATEGY_NOT_SUITABLE, WITHDRAWAL_REQUESTED

Response

200 - application/json

meta · object · required

Pagination metadata. Use has_next/has_previous for boolean page checks and next/previous for page URLs.

Show child attributes

Example:

{
  "count": 123,
  "page": 1,
  "page_size": 20,
  "total_pages": 7,
  "has_next": true,
  "has_previous": false,
  "next": "https://api.example.org/resources/?page=2",
  "previous": null
}

results · object[] · required

Show child attributes