Skip to content

GET Get ROI Statistics

Endpoint

GET /stats/roi

Description

Returns account equity history for the authenticated client login within the requested time range.

The response is shaped for chart rendering and includes summary info with minimum and maximum equity values.

Request Parameters

Name Type Required Description
from int Yes Start UNIX timestamp
to int Yes End UNIX timestamp
login int Yes Client account login

Request Example

GET /stats/roi?from=1733011200&to=1733097600&login=10001
Authorization: Bearer <JWT_TOKEN>

Response Parameters

Name Type Description
structure array Ordered field list used in each row
rows array Equity history rows
info object Aggregate info for the requested period

Each row contains:

  1. create_time
  2. balance
  3. equity
  4. profit
  5. margin
  6. margin_free

Response Example

{
  "structure": ["create_time", "balance", "equity", "profit", "margin", "margin_free"],
  "rows": [
    [1733011200, 1000.0, 1025.5, 25.5, 100.0, 925.5],
    [1733014800, 1000.0, 1012.0, 12.0, 80.0, 932.0]
  ],
  "info": {
    "max_equity": 1025.5,
    "min_equity": 1012.0
  }
}