Developer Portal
Trader APIsHTTP APIConfiguration

Symbols (Compact)GET

Returns a short version of the symbol list for menus and search. Leaves out the account's trading terms and live prices.

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

Authorization

AuthorizationRequiredBearer <token>

JWT token obtained from the login endpoint

In: header

Path Parameters

account_idRequiredstring

Account ID to fetch symbols for

curl -X GET "http://localhost:8081/api/v1/accounts/acc_123456/symbols/compact" \
  -H "Authorization: Bearer <token>"

Successfully retrieved compact symbols

{
  "symbols": [
    {
      "id": "EURUSD",
      "name": "EURUSD",
      "description": "Euro vs US Dollar",
      "group_id": "retail_group_1",
      "group_name": "Forex Majors",
      "asset_class": "ASSET_CLASS_FOREX_CFD",
      "instrument_type": "INSTRUMENT_TYPE_CFD",
      "status": "TRADE_STATUS_FULL",
      "digits": 5,
      "tick_size": 0.00001,
      "contract_size": 100000,
      "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,
      "margin_rate": 0.01,
      "trade_sessions": [
        {
          "from": 28800,
          "to": 61200
        }
      ],
      "bid": 1.08525,
      "ask": 1.08535,
      "change": 0.12,
      "timestamp": 1754766471
    }
  ]
}

Symbol by ID

Returns the full details of a single symbol for the authenticated account's group. Supports HTTP ETag revalidation; the response includes a strong `ETag` header derived from the symbol's last update time, and clients (browsers) sending `If-None-Match` will receive `304 Not Modified` when the cached representation is still fresh.

Symbols

Returns the symbols this account can trade, including the trading terms that apply to it — volume limits, stop distances, commissions and trading hours. Optionally filterable by a list of symbol IDs.