MetaTrader 5 icon

MetaTrader 5

Interact with MetaTrader 5 trading platform via WebAPI

Symbols → Get Symbol Configuration

AI-generated

Summary

Retrieve configuration details of trading symbols from the MetaTrader 5 platform by specifying either an exact symbol name or a mask pattern with wildcards and exclusions.

Inputs

  • Symbol Name or Mask (required) — Provide a specific symbol name (e.g., EURUSD) or use a mask pattern with wildcards () or exclusions (!) to specify multiple symbols (e.g., Forex, *, !Forex\EURUSD).
  • Query Type (required) — Choose whether to query by a single exact symbol name or multiple symbols using a mask pattern with wildcards and exclusions.

Output shape

a list of symbol configuration objects or a single symbol configuration object

The output shape depends on the query type: 'Single Symbol' returns the configuration of exactly one symbol, while 'Multiple Symbols (Mask)' returns configurations for all matching symbols. If no symbols match the query, the response may be empty. The results are returned as JSON objects representing the symbol configuration details from the MetaTrader 5 WebAPI.

Discussion