Developer Portal
Trader APIsHTTP APIConfiguration

SymbolsGET

Returns a list of trading symbols for a specific account group, enriched with template data. Optionally filterable by a list of symbol IDs.

View as Markdown
GET
/accounts/{account_id}/symbols

Authorization

AuthorizationRequiredBearer <token>

JWT token obtained from the login endpoint

In: header

Path Parameters

account_idRequiredstring

Account ID to fetch symbols for

Query Parameters

idsstring

Comma-separated list of symbol IDs (max 100) to filter the response. When omitted, all permitted symbols for the account's group are returned. Unknown or non-permitted IDs are silently ignored. Requests exceeding 100 IDs return 400.

curl -X GET "http://localhost:8081/api/v1/accounts/acc_123456/symbols?ids=EURUSD%2CGBPUSD" \
  -H "Authorization: Bearer <token>"

Successfully retrieved symbols

{
  "symbols": [
    {
      "id": "EURUSD",
      "name": "EURUSD",
      "group_id": "retail_group_1",
      "group_name": "Forex Majors",
      "description": "Euro vs US Dollar",
      "asset_class": "ASSET_CLASS_FOREX_CFD",
      "instrument_type": "INSTRUMENT_TYPE_CFD",
      "status": "TRADE_STATUS_FULL",
      "digits": 5,
      "contract_size": 100000,
      "tick_size": 0.00001,
      "base_asset": "EUR",
      "quote_asset": "USD",
      "lot_name": "Lot",
      "timezone": "America/New_York",
      "volume_min": 0.01,
      "volume_max": 100,
      "volume_step": 0.01,
      "stop_loss_min_distance": 50,
      "take_profit_min_distance": 50,
      "limit_min_distance": 10,
      "stop_min_distance": 10,
      "margin_rate": 0.01,
      "leverage_tiers": [
        {
          "leverage": 100,
          "exposure_level_usd": 50000
        }
      ],
      "commission_rate": 2.5,
      "commission_mode": "COMMISSION_MODE_USD_PER_MILLION",
      "min_commission": 1,
      "trade_sessions": [
        {
          "from": 28800,
          "to": 61200
        }
      ],
      "quote_sessions": [
        {
          "from": 28800,
          "to": 61200
        }
      ],
      "bid": 1.08525,
      "ask": 1.08535,
      "change": 0.12,
      "timestamp": 1754766471
    }
  ]
}

Symbols (Compact)

Returns a compact projection of trading symbols for an account group, intended for list views and search. Excludes template-derived and real-time pricing fields.

Get Economic Calendar

Returns economic calendar events, optionally scoped to a symbol. When a symbol_id is supplied, relevance is determined by the symbol's base and quote assets (currency filter) and its asset class (category filter); when omitted, all events in the window are returned. An explicit currencies or categories param overrides the symbol-derived defaults. Results can be bounded by a from/to date range. No authentication required.