Get balance, equity and reporting fields for accounts

Returns paginated accounts for end-of-day reporting. By default, returns only ACTIVE accounts. Pass ?status=FAILED, another AccountStatusChoices value, or ?status=all to broaden the result set. Combine with ?disabled_at_after= and ?disabled_at_before= to scope results to a window of when the account entered its terminal state (max window: 31 days; useful for daily failed-account roll-ups). Staff users see all accessible accounts; regular users see only their own.

GET /api/accounts/balance-equity/

Get balance, equity and reporting fields for accounts

cURL

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

200

SuccessResponse-ActiveAccount

{
  "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,
      "user_id": 50,
      "challenge_short_code": "001122",
      "balance": 50000,
      "equity": 52500.5,
      "broker_type": "MATCH_TRADER",
      "status": "ACTIVE",
      "status_reason": null,
      "custom_status_reason": null,
      "disabled_at": null,
      "closed_pnl_today": "120.50",
      "initial_balance": "50000.00",
      "trading_days": 4
    }
  ]
}

Authorizations

Authorization · string · header · required

Token-based authentication with required prefix "Token"

Query Parameters

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.

page · integer

A page number within the paginated result set.

page_size · integer

Number of results to return per page.

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.

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