List online users (cached)
GET /api/v2/MT4/{tradePlatform}/OnlineGet
Pump-cached snapshot of currently online users, paginated by login.
Pump-cached read — instant local lookup, no MT4 round-trip. Sort
order is the login ascending. ?limit= caps the page size;
without it the full set returns in one page. When the pump cache
is not yet warmed (fresh connection) the response is a NoConnect
error with a retry hint, not an empty list — empty list means
"warmed but currently no online sessions".
Timeout: 10 s by default, adjustable per request with the X-Request-Timeout header. When the trade server does not answer in time: Nothing was changed; the request is safe to repeat.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| tradePlatform | path | string (uuid) | yes | |
| limit | query | integer (int32) | no | Maximum number of items to return in one page. Omit to return all items in a single page. Maximum allowed value is 5000. |
| cursor | query | string | no | Opaque continuation token. Pass the value from the previous response's meta.paging.nextCursor to fetch the next page; omit for the first page. |
| X-Request-Timeout | header | number (double) | no | How long to wait for the trade server, in seconds (1–300). Default for this operation: 10 s (read). The query parameter requestTimeout does the same for clients that cannot set headers. The applied value is returned in the X-Request-Timeout-Applied response header. |
Responses
- 200 Success — MT4OnlineListApiResponse
Example
curl "https://cloud.mywebapi.com/api/v2/MT4/$TRADE_PLATFORM_ID/OnlineGet" \
-H "Authorization: Bearer $TOKEN"