> ## Documentation Index
> Fetch the complete documentation index at: https://docs.novosky.app/llms.txt
> Use this file to discover all available pages before exploring further.

# List available symbols

> Returns symbol names available on the broker. Optionally filter by group (e.g. `?group=*BTC*` for all Bitcoin pairs). Used by the bot's symbol auto-discovery to find the correct BTC/USD pair name.



## OpenAPI

````yaml https://terminal-api.novosky.tech/roboforex/main/openapi.json get /symbols
openapi: 3.0.3
info:
  description: >-
    Self-hosted HTTP REST API bridging the NOVOSKY trading bot to a MetaTrader 5
    terminal. All bot-to-broker communication goes through this service.
    Authentication is required on all endpoints except `GET /ping`.
  title: MT5 HEADLESS
  version: 1.0.0
servers:
  - url: /
security:
  - bearerAuth: []
tags:
  - description: Health, latency, and error diagnostics
    name: System
  - description: MT5 terminal lifecycle and server time
    name: Terminal
  - description: Broker server time and UTC offset detection
    name: Time
  - description: Live balance, equity, and margin
    name: Account
  - description: Symbol specs, ticks, and OHLCV rates
    name: Symbols
  - description: Open position management
    name: Positions
  - description: Pending order placement and management
    name: Orders
  - description: Closed deals and historical orders
    name: History
paths:
  /symbols:
    get:
      tags:
        - Symbols
      summary: List available symbols
      description: >-
        Returns symbol names available on the broker. Optionally filter by group
        (e.g. `?group=*BTC*` for all Bitcoin pairs). Used by the bot's symbol
        auto-discovery to find the correct BTC/USD pair name.
      operationId: list_symbols
      parameters:
        - description: Symbol group filter pattern (MT5 wildcard syntax).
          in: query
          name: group
          required: false
          schema:
            example: '*BTC*'
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                example:
                  - BTCUSD
                  - BTCUSDm
                items:
                  type: string
                type: array
          description: Symbol name list
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Missing or invalid Bearer token
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: MT5 not initialized
components:
  schemas:
    ErrorResponse:
      additionalProperties: true
      description: MT5 error payload returned on non-2xx responses.
      properties:
        message:
          example: Invalid stops
          type: string
        retcode:
          description: MT5 error code (e.g. 10014 = invalid stops, 10018 = market closed).
          example: 10014
          type: integer
      type: object
  securitySchemes:
    bearerAuth:
      description: Set `API_TOKEN` in `.env` to match the token configured on the server.
      scheme: bearer
      type: http

````