Skip to content

GetSymbol

Description: Retrieves the full configuration and metadata of a specific trading symbol by name.

Access Control

🛡️ Access Level Required: SESSION_USER, SESSION_MANAGER, SESSION_ADMIN, SESSION_DEALER

For staff sessions, requires market_watch. The requested symbol must be visible through manager account groups loaded from the cached staff manager record.

Request Parameters

Name Type Required Description
symbol string Yes Symbol name

Response Parameters

The method returns the symbol fields directly at the top level. There is no data wrapper.

Key fields include:

  • symbol, description, currency, margin_currency, quote_currency
  • source, quote_policy_id, background_color
  • sec_index, sort_index, sym_index
  • digits, trade, realtime, starting, expiration
  • profit_mode, exemode
  • spread, spread_balance
  • swap_*
  • stops_level, gtc_pendings
  • filter*, logging
  • margin_*
  • instant_max_volume, contract_size, multiply, count, long_only, freeze_level
  • ask, bid, tick_time, ask_tickvalue, bid_tickvalue, point, tick_value, tick_size, max_volume, quotes_delay
  • sessions

quote_policy_id references a quote policy configured through the Quote Policies API. The legacy feeder field is no longer part of the public symbol contract.

Error Responses

Code Error Description
400 INVALID_DATA Missing or invalid symbol
401 RET_* Symbol retrieval failed