接続の確立

API

cTrader Open APIプロキシには、TCPプロトコルまたはWebSocketプロトコルを使用して接続できます。このガイドでは、これらのオプションの両方をカバーしています。

TCPの使用¶

SSLの使用

TCPクライアント接続はSSLを使用する必要があります。そうしないと、APIに接続したり対話したりすることができません。

公式のcTrader Open API SDKを使用して、次のように接続を確立できます。

1
2
_client = new OpenClient("live1.p.ctrader.com", 5035, TimeSpan.FromSeconds(10), useWebSocket: false);
await _client.Connect()

OpenClient.Connect()メソッドはOpenClient.ConnectTcp()メソッドを呼び出します。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
private async Task ConnectTcp()
{
    _tcpClient = new TcpClient
    {
        LingerState = new LingerOption(enable: true, 10)
    };
    await _tcpClient.ConnectAsync(Host, Port).ConfigureAwait(continueOnCapturedContext: false);
    _sslStream = new SslStream(_tcpClient.GetStream(), leaveInnerStreamOpen: false);
    await _sslStream.AuthenticateAsClientAsync(Host).ConfigureAwait(continueOnCapturedContext: false);
    Task.Run(delegate
    {
        ReadTcp(_cancellationTokenSource.Token);
    });
}

WebSocketを介して¶

WebSocketプロトコルを介して接続する場合、ホストとポートはTCPプロトコルを介して接続する場合と同じです。

公式のcTrader Open API SDKがWebSocket経由で接続を確立する方法は次のとおりです。

1
2
_client = new OpenClient("live1.p.ctrader.com", 5035, TimeSpan.FromSeconds(10), useWebSocket: true);
await _client.Connect()

OpenClient.Connect()メソッドはOpenClient.ConnectWebSocket()メソッドを呼び出します

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
private async Task ConnectWebScoket()
{
    DefaultInterpolatedStringHandler defaultInterpolatedStringHandler = new DefaultInterpolatedStringHandler(7, 2);
    defaultInterpolatedStringHandler.AppendLiteral("wss://");
    defaultInterpolatedStringHandler.AppendFormatted(Host);
    defaultInterpolatedStringHandler.AppendLiteral(":");
    defaultInterpolatedStringHandler.AppendFormatted(Port);
    Uri url = new Uri(defaultInterpolatedStringHandler.ToStringAndClear());
    _websocketClient = new WebsocketClient(url, () => new ClientWebSocket())
    {
        IsTextMessageConversionEnabled = false,
        ReconnectTimeout = null,
        IsReconnectionEnabled = false,
        ErrorReconnectTimeout = null
    };
    _webSocketMessageReceivedDisposable = _websocketClient.MessageReceived.Select((ResponseMessage msg) => ProtoMessage.Parser.ParseFrom(msg.Binary)).Subscribe(new Action<ProtoMessage>(OnNext));
    _webSocketDisconnectionHappenedDisposable = _websocketClient.DisconnectionHappened.Subscribe(new Action<DisconnectionInfo>(OnWebSocketDisconnectionHappened));
    await _websocketClient.StartOrFail();
}

cTrader Open APIに接続する際のいくつかのガイドラインを次に示します。

  • 最大で2つの接続を作成できます。デモアカウントとライブアカウント用に1つずつです。各接続は、特定のタイプのアカウントの無制限の数をサポートできます。
  • 接続が確立された後、アプリケーションの認証フローを渡す必要があります。アプリケーションが認証される前にメッセージを送信すると、エラーが発生します。
  • 接続を維持するには、10秒ごとにハートビートイベント(ProtoHeartbeatEvent)を送信し続けます。
  • 送信/受信するデータのキューを使用して、同時送信/受信イベントを回避します。

このページについて