Skip to content
mcp..aiBeta

Get Symbols

read-only · idempotent

Query the symbol catalog to look up FIX symbol IDs, lot sizes, digits, and metadata.

Returns all configured trading symbols with their broker-specific parameters. Use this BEFORE placing orders to verify the correct symbol ID, lot size, and digits.

RESPONSE FIELDS (per symbol):

  • symbol: Symbol name (e.g., “EURUSD”)
  • id: Broker-specific FIX Symbol ID (numeric)
  • lotSize: Units per 1 standard lot (e.g., 100000 for FX, 10 for XAUUSD)
  • minVolume: Minimum order volume in units (0.01 lot)
  • volumeStep: Volume increment in units (0.01 lot)
  • digits: Price decimal places (e.g., 5 for EURUSD, 2 for XAUUSD)
  • description: Human-readable symbol description
  • baseAsset / quoteAsset: Currency pair components
  • assetClass: Forex, Metals, Crypto, Indices, Energies
  • enabled: Whether the symbol is tradeable (whitelisted)

FILTERS (all optional):

  • symbol: Substring match on symbol name (e.g., “EUR” returns EURUSD, EURJPY, EURGBP, …)
  • assetClass: Exact match on asset class (e.g., “Metals”)
  • enabledOnly: When true, only returns tradeable symbols

USAGE:

  • Call without parameters to list ALL symbols
  • Use symbol filter to find a specific instrument
  • Use assetClass to browse by category
  • Use enabledOnly=true to see what you can trade right now

This is a read-only operation with no risk checks.

Parameters

Section titled “Parameters”
ParameterTypeRequiredDescription
symbolstringNoOptional symbol name filter (substring match, e.g., ‘EUR’ matches EURUSD, EURJPY, etc.)
assetClassstringNoOptional asset class filter (e.g., ‘Forex’, ‘Metals’, ‘Crypto’, ‘Indices’, ‘Energies’)
enabledOnlybooleanNoWhen true, only return enabled (tradeable) symbols. Default false returns all symbols. Default: false.