MetaTrader 5 icon

MetaTrader 5

Interact with MetaTrader 5 trading platform via WebAPI

Client → Get Client

AI-generated

Summary

Retrieve client record(s) from the MetaTrader 5 platform by ID or comma-separated list.

Inputs

  • clientId — Client record ID. Used to fetch a single client via /api/client/get?id={id}.
  • clientIds — Comma-separated list of client IDs (e.g., 123,456,789). When provided, fetches multiple clients via /api/client/get?id=123,456,789.
  • simplify — Whether to return a simplified version of the response instead of the raw data.

Output shape

When simplify is true (default), the response is transformed by simplifyClientData to expose fields: RecordID, PersonName, ContactEmail, ContactPhone, ClientStatus, ClientType, DateCreated, AssignedManager, LeadSource. When false, the raw API response is returned.

If clientIds is empty or omitted and clientId is also empty, the API may return an error or all clients depending on server behavior; the node handles this via the getClient/getClients internal logic.

Examples

Example 1: Get a single client by ID

Set clientId to the desired record ID; simplify defaults to true.

Example 2: Get multiple clients at once

Set clientIds to '123,456,789'; simplify defaults to true.

Discussion