MetaTrader 5Install

Summary

Retrieve a list of client IDs from the MetaTrader 5 platform, optionally filtered by a trading group pattern.

Inputs

• Trading Group Filter — String filter to limit results to clients in trading groups matching this pattern (supports wildcards like "demo*")
• Simplify — Boolean to determine if the response should be simplified to essential fields rather than retrieving raw data

Output shape

an array of client IDs, either as raw API response objects or simplified client data objects

The output may be a simplified version if 'Simplify' is true; otherwise, it returns raw data from the API.

Examples

Example 1: Get all client IDs without filtering

Set 'Trading Group Filter' empty and 'Simplify' to true or false to get all client IDs with chosen response detail.

Example 2: Get client IDs filtered by a trading group pattern

Set 'Trading Group Filter' to a pattern like 'demo*' to retrieve only client IDs from matching trading groups.