共通メッセージ

API

ProtoErrorRes

エラー応答は、エラーが発生したときにOpen APIプロキシから送信されます。

フィールド タイプ ラベル 説明
payloadType ProtoPayloadType オプション  
errorCode string 必須 ProtoErrorCodeの名前またはその他のカスタムエラーコード(例:ProtoCHErrorCode)を含みます。
description string オプション エラーの説明。
maintenanceEndTimestamp uint64 オプション メンテナンスの終了時刻のUnix時間(ミリ秒単位)。

ProtoHeartbeatEvent

Open APIプロキシから送信されるイベントで、cTraderプラットフォームから他のメッセージが送信されない場合に接続が健全であると判断できます。

Open APIクライアントは、他のメッセージが30秒以上送信されない期間、接続を開いたままにする必要がある場合にこのメッセージを送信できます。

フィールド タイプ ラベル 説明
payloadType ProtoPayloadType オプション  

ProtoMessage

Open APIプロキシの送受信されるすべてのメッセージに使用されるベースメッセージ。

フィールド タイプ ラベル 説明
payloadType uint32 必須 ProtoPayloadTypeまたはその他のカスタムPayloadTypes(例:ProtoOAPayloadType)のIDを含みます。
payload bytes オプション payloadTypeに対応するシリアル化されたprotobufメッセージ。
clientMsgId string オプション クライアントによって割り当てられたリクエストメッセージID、応答で返されます。