Skip to content

Get symbol

GetSymbol

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

Response Parameters

Name Type Description
symbol string Symbol name
description string Full name/description
currency string Account currency
margin_currency string Margin calculation currency
quote_currency string Quotation currency
source string Data source
background_color string Background color for UI
sec_index int Security group index
sort_index int Sorting index
sym_index int Internal symbol index
digits int Price precision
trade int 1 if tradable
realtime int 1 if real-time quotes
starting int Starting time
expiration int Expiration time
profit_mode int Profit calculation mode
exemode int Execution mode
spread int Spread in points
spread_balance int Spread for balance
swap_enable int 1 if swap is enabled
swap_type int Swap type
swap_long double Long position swap
swap_short double Short position swap
swap_rollover3days int Rollover day for triple swap
swap_openprice int Swap open price mode
swap_variation_margin int Swap affects margin
stops_level int Minimal stop distance in points
gtc_pendings int Good-Till-Cancel pending orders allowed
filter int Price filtering option
filter_counter int Counter for price filter
filter_limit double Maximum allowed price deviation
filter_smoothing int Smoothing factor for price filter
filter_reserved double Reserved for future use
logging int Enable logging (1 = yes)
margin_mode int Margin calculation mode
margin_initial double Initial margin requirement
margin_maintenance double Maintenance margin
margin_divider double Divider for margin scaling
margin_hedged double Margin for hedged positions
instant_max_volume int Maximum volume for instant execution
contract_size double Contract size
multiply double Multiplier
count int Quote count
long_only int 1 if only long positions are allowed
freeze_level int Freeze level in points
margin_hedged_strong int Strong hedged margin enabled
value_date int Settlement date
ask double Current ask price
bid double Current bid price
lasttime int Last quote timestamp
ask_tickvalue double Value of one tick for ask
bid_tickvalue double Value of one tick for bid
point double Point size
tick_value double Value per tick
tick_size double Size of a tick
max_volume int Max trade volume allowed
quotes_delay int Delay in quotes
sessions array Weekly trading session config (7 days)

Each session includes:

  • trade_overnight: 1 if overnight trades allowed
  • trade: array of 3 time intervals (each includes open_hour, open_min, close_hour, close_min)

Request Example

{
  "symbol": "EURUSD"
}

Response Parameters

Name Type Description
data object Object containing full symbol configuration SymbolRecord

The data object contains all the symbol fields, including trading properties, pricing, margin, and session times.

Example Fields Returned

  • symbol, description, currency, margin_currency, quote_currency
  • digits, trade, realtime, starting, expiration
  • spread, swap_long, swap_short, margin_initial, margin_maintenance
  • ask, bid, lasttime, tick_value, tick_size, contract_size
  • sessions (per weekday, with trading hours)

Response Example (truncated)

{
  "data": {
    "symbol": "EURUSD",
    "description": "Euro vs US Dollar",
    "currency": "USD",
    "margin_currency": "USD",
    "digits": 5,
    "spread": 20,
    "swap_long": -3.5,
    "swap_short": 1.5,
    "ask": 1.1050,
    "bid": 1.1045,
    "sessions": [
      {
        "trade_overnight": 1,
        "trade": [
          { "open_hour": 0, "open_min": 0, "close_hour": 23, "close_min": 59 },
          ...
        ]
      }
    ]
  }
}