AboutSupportDeveloper GuideVersion 2.0.0
  • Establishes a connection to the Terminal.

    A Bloomberg Terminal Connect API key is required to establish a connection (contact your Bloomberg account manager for more information).

    Note: the Terminal must be running locally and logged in, otherwise an error will be thrown.

    Parameters

    • apiKey: string

      Bloomberg Terminal Connect API key.

    • Optional config: BloombergConnectionConfig

      Connection configuration settings (if not provided, the default configuration is used).

    Returns Promise<BloombergConnection>

    Throws

    InitializationError if an error occurs when initializing the background adapter process.

    Throws

    TerminalConnectionError if an error occurs when attempting to connect to the Terminal.

    Throws

    TerminalConnectRequestError if a Terminal Connect API request fails.

    Throws

    InteropError if an error occurs when initializing interop functionality.

    Throws

    AdapterError if an unexpected error is thrown by the background adapter process.

    Throws

    ApiError if an unexpected error is thrown by the API.

Generated using TypeDoc