> ## 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.

# Get terminal info

> Returns `mt5.terminal_info()` fields including connection state, build number, trade permissions, and latency.



## OpenAPI

````yaml https://terminal-api.novosky.tech/roboforex/main/openapi.json get /terminal
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:
  /terminal:
    get:
      tags:
        - Terminal
      summary: Get terminal info
      description: >-
        Returns `mt5.terminal_info()` fields including connection state, build
        number, trade permissions, and latency.
      operationId: get_terminal_info
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TerminalInfoResponse'
          description: Terminal info
        '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:
    TerminalInfoResponse:
      additionalProperties: true
      description: MT5 terminal_info() fields.
      properties:
        build:
          type: integer
        community_account:
          type: boolean
        community_connection:
          type: boolean
        connected:
          type: boolean
        dlls_allowed:
          type: boolean
        name:
          example: MetaTrader 5
          type: string
        path:
          type: string
        ping_last:
          type: integer
        retransmission:
          type: number
        trade_allowed:
          type: boolean
      type: object
    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

````