@mywebapi.com/sdk - v0.1.0
    Preparing search index...

    Class CPluginWebApiClient

    Unified entry point for the CPlugin SaaS WebAPI v2 — MT4 and MT5 trading platform management.

    Client credentials (ID and secret) and trade platform configuration are managed in the CPlugin Toolbox (staging: https://pre.toolbox.cplugin.com, production: https://toolbox.cplugin.com). Once configured, access all MT4 and MT5 endpoints via the mt4 and mt5 namespaces and discover available platforms via listTradePlatforms(). Token management (OAuth2 client credentials flow) is handled automatically.

    Index

    Constructors

    Properties

    Methods

    Constructors

    Properties

    mt4: MT4Namespace

    All MT4 v2 endpoint functions, pre-wired to this client's context.

    mt5: MT5Namespace

    All MT5 v2 endpoint functions, pre-wired to this client's context.

    realtime: {
        mt4(
            tradePlatform: string,
            extras?: SignalRClientExtras,
        ): MT4V2SignalRClient;
        mt5(
            tradePlatform: string,
            extras?: SignalRClientExtras,
        ): MT5V2SignalRClient;
    }

    Type Declaration

    Methods

    • Discover trade platforms available to the authenticated principal.

      Trade platforms are managed in the CPlugin Toolbox (staging: https://pre.toolbox.cplugin.com, production: https://toolbox.cplugin.com). Use the returned platform id values as the tradePlatform parameter for all MT4 and MT5 endpoint calls.

      Returns Promise<TradePlatform[]>

      Array of trade platforms the authenticated user can access.

      ApiError if authentication fails or the API request returns an error.