メッセージ

API

ProtoOAAccountAuthReq

取引口座セッションの認証リクエスト。

ProtoOAApplicationAuthReqを使用して、クライアントアプリケーションとの確立された認証済み接続が必要です。

フィールドラベル説明
payloadTypeProtoOAPayloadTypeオプション 
ctidTraderAccountIdint64必須cTraderプラットフォーム内のトレーダーアカウントの一意の識別子。
accessTokenstring必須トレーダーアカウントへのアクセスを提供するために発行されたアクセストークン。

ProtoOAAccountAuthRes

ProtoOAApplicationAuthResリクエストへのレスポンス。

フィールドラベル説明
payloadTypeProtoOAPayloadTypeオプション 
ctidTraderAccountIdint64必須cTraderプラットフォーム内のトレーダーアカウントの一意の識別子。

ProtoOAAccountDisconnectEvent

サーバーサイドでトレーダーアカウントの確立されたセッションが終了したときに送信されるイベント。

アカウントの新しいセッションを認証する必要があります。

フィールドラベル説明
payloadTypeProtoOAPayloadTypeオプション 
ctidTraderAccountIdint64必須cTraderプラットフォーム内のトレーダーアカウントの一意の識別子。

ProtoOAAccountLogoutReq

トレーディングアカウントセッションのログアウトリクエスト。

フィールドラベル説明
payloadTypeProtoOAPayloadTypeオプション 
ctidTraderAccountIdint64必須cTraderプラットフォーム内のトレーダーアカウントの一意の識別子。

ProtoOAAccountLogoutRes

ProtoOATraderLogoutReqリクエストへのレスポンス。

トレーディングアカウントの実際のログアウトは、ProtoOAAccountDisconnectEventで完了します。

フィールドラベル説明
payloadTypeProtoOAPayloadTypeオプション 
ctidTraderAccountIdint64必須cTraderプラットフォーム内のトレーダーアカウントの一意の識別子。

ProtoOAAccountsTokenInvalidatedEvent

特定のトレーダーアカウントへのセッションがサーバーによって終了されたときに送信されるイベントが送信されますが、他のトレーダーアカウントとの既存の接続は維持されます。

フィールドラベル説明
payloadTypeProtoOAPayloadTypeオプション 
ctidTraderAccountIdsRepeatedField<int64>繰り返しcTraderプラットフォーム内のトレーダーアカウントの一意の識別子。
reasonstringオプション説明された切断理由。たとえば: アクセストークンが期限切れまたは回収されました。

ProtoOAAmendOrderReq

既存の保留中の注文を修正するためのリクエスト。

アクセストークンに「トレード」権限がある場合のみ許可されます。

フィールドラベル説明
payloadTypeProtoOAPayloadTypeオプション 
ctidTraderAccountIdint64必須トレーダーアカウントの一意の識別子。応答をトレーダーアカウントに一致させるために使用されます。
orderIdint64必須注文の一意のID。
volumeint64オプションボリューム、0.01単位で表されます(例: セント)。
limitPricedoubleオプションリミット価格、LIMIT注文の場合に指定できます。
stopPricedoubleオプションストップ価格、STOP注文の場合に指定できます。
expirationTimestampint64オプション時間のUNIXタイムスタンプ、注文が無効になる日時。
slTpModeProtoOASlTpModeオプション停止損失と利益の取得の注文モード、利用可能なモードについては: OASlTpMode 。
sldoubleオプション停止損失、STOPおよびMARKET_RANGE注文で利用可能。
tpdoubleオプション利益の取得、STOPおよびMARKET_RANGE注文で利用可能。
commentstringオプション注文に関する追加のコメント。

ProtoOAAmendOrderRes

ProtoOAAmendOrderReqリクエストへのレスポンス。

注文の変更が失敗した場合は、失敗理由をエラーメッセージフィールドに格納します。

フィールドラベル説明
payloadTypeProtoOAPayloadTypeオプション 
errorCodeProtoOAAmendOrderErrorCodeオプション 
errorMessagestringオプション注文変更が失敗した理由。失敗しなかった場合は未定義です。

ProtoOAAmendOrderErrorCode

注文変更のエラーコード。

名前番号説明
ORDER_NOT_FOUND1指定されたIDの注文が見つかりません。
INVALID_NEW_ORDER2新しい注文情報が無効です。
INVALID_ORDER_ID3注文IDが無効です。
INTERNAL_SERVER_ERROR4内部サーバーエラー。
TRADE_DISABLED5トレードが無効になっています。

ProtoOATradeServerTokenInvalidatedEvent

取引サーバーによってアクセストークンが無効にされたときに送信されるイベント。

フィールドラベル説明
payloadTypeProtoOAPayloadTypeオプション 
accessTokenstringオプション無効になったアクセストークン。
reasonstringオプション無効な理由。たとえば: アクセストークンが期限切れまたは回収されました。

ProtoOAGetCTIDProfileImageURLReq

特定のトレーダーアカウントのプロフィール画像のURLを取得するためのリクエスト。

権限の範囲内で利用可能な最大の画像の画素数は64×64です。

フィールドラベル説明
payloadTypeProtoOAPayloadTypeオプション 
ctidTraderAccountIdint64必須トレーダーアカウントの一意の識別子。

ProtoOAGetCTIDProfileImageURLRes

ProtoOAGetCTIDProfileImageURLReqリクエストへのレスポンス。

フィールドラベル説明
payloadTypeProtoOAPayloadTypeオプション 
profileImageUrlstring必須プロフィール画像のURL。

ProtoOADealListRes

ProtoOADealListResリクエストへの応答です。

FieldTypeLabelDescription
payloadTypeProtoOAPayloadTypeOptional 
ctidTraderAccountIdint64Requiredトレーダーアカウントの一意の識別子。応答をトレーダーアカウントに一致させるために使用されます。
dealRepeatedField<ProtoOADeal>Repeated取引のリスト。
hasMoreboolRequiredTRUEの場合、フィルターによるレコード数がchunkSizeよりも大きい場合、応答にはchunkSizeと同じ数のレコードが含まれます。

ProtoOADealOffsetListReq

特定の取引によってオフセットされた取引セットを取得するためのリクエストで、その取引をオフセットする取引を取得します。

FieldTypeLabelDescription
payloadTypeProtoOAPayloadTypeOptional 
ctidTraderAccountIdint64Requiredトレーダーアカウントの一意の識別子。応答をトレーダーアカウントに一致させるために使用されます。
dealIdint64Required取引の一意のID。

ProtoOADealOffsetListRes

ProtoOADealOffsetListReqの応答です。

FieldTypeLabelDescription
payloadTypeProtoOAPayloadTypeOptional 
ctidTraderAccountIdint64Requiredトレーダーアカウントの一意の識別子。応答をトレーダーアカウントに一致させるために使用されます。
offsetByRepeatedField<ProtoOADealOffset>Repeated指定された取引を閉じた取引。
offsettingRepeatedField<ProtoOADealOffset>Repeated指定された取引によって閉じられた取引。

ProtoOADepthEvent

深さの構造が変更されたときに送信されるイベント。

シンボルの深さの市場にサブスクリプションが必要です。ProtoOASubscribeDepthQuotesReqを参照してください。

FieldTypeLabelDescription
payloadTypeProtoOAPayloadTypeOptional 
ctidTraderAccountIdint64Requiredトレーダーアカウントの一意の識別子。応答をトレーダーアカウントに一致させるために使用されます。
symbolIduint64RequiredcTraderプラットフォーム内のシンボルの一意の識別子。
newQuotesRepeatedField<ProtoOADepthQuote>Repeated市場の深さの見積もりの変更のリスト。
deletedQuotesRepeatedField<uint64>Repeated削除する見積もりのリスト。

ProtoOAErrorRes

エラーが発生した場合の汎用応答。

FieldTypeLabelDescription
payloadTypeProtoOAPayloadTypeOptional 
ctidTraderAccountIdint64Requiredトレーダーアカウントの一意の識別子。応答をトレーダーアカウントに一致させるために使用されます。
errorProtoOAErrorOptionalエラーの詳細。

ProtoOAGetTrendbarsRes

ProtoOAGetTrendbarsReq リクエストへのレスポンス。

フィールドタイプラベル説明
payloadTypeProtoOAPayloadTypeオプション 
ctidTraderAccountIdint64必須トレーダーのアカウントの一意の識別子。レスポンスをトレーダーのアカウントに一致させるために使用されます。
periodProtoOATrendbarPeriod必須トレンドバーのシリーズの期間を指定します(例:M1、M10など)。
timestampint64オプションこのフィールドを使用しないでください。元のリクエストにはすでにtoTimestampが含まれています。
trendbarRepeatedField<ProtoOATrendbar>繰り返しトレンドバーのリスト。
symbolIdint64オプションcTraderプラットフォームのシンボルの一意の識別子。
hasMoreboolオプションTRUEの場合、フィルターによるレコード数がchunkSizeよりも大きい場合、レスポンスにはchunkSizeと同じ数のレコードが含まれます。

ProtoOAMarginCallListReq

ユーザーに構成された既存の証拠金コールしきい値のリストをリクエストします。

フィールドタイプラベル説明
payloadTypeProtoOAPayloadTypeオプション 
ctidTraderAccountIdint64必須 

ProtoOAMarginCallListRes

既存のユーザーのマージンコールのリストを含むレスポンス。通常は3つのアイテムを含みます。

フィールドタイプラベル説明
payloadTypeProtoOAPayloadTypeオプション 
marginCallRepeatedField<ProtoOAMarginCall>繰り返し 

ProtoOAMarginCallTriggerEvent

マージンコールがトリガーされたことを通知するイベント。

フィールドタイプラベル説明
payloadTypeProtoOAPayloadTypeオプション 
marginCallProtoOAMarginCall必須トリガーされたマージンコールイベントの詳細。

ProtoOAMarginCallUpdateEvent

マージンコールのしきい値設定が更新された際に送信されるイベント。

フィールドラベル説明
payloadTypeProtoOAPayloadTypeOptional 
ctidTraderAccountIdint64Required 
marginCallProtoOAMarginCallRequired 

ProtoOAMarginCallUpdateReq

指定されたctidTraderAccountIdのmarginLevelThresholdを変更するためのリクエスト。

フィールドラベル説明
payloadTypeProtoOAPayloadTypeOptional 
ctidTraderAccountIdint64Required 
marginCallProtoOAMarginCallRequired 

ProtoOAMarginCallUpdateRes

この応答が受信されると、マージンコールが正常に更新されたことを意味します。

フィールドラベル説明
payloadTypeProtoOAPayloadTypeOptional 

ProtoOAMarginChangedEvent

特定のポジションに割り当てられたマージンが変更された際に送信されるイベント。

フィールドラベル説明
payloadTypeProtoOAPayloadTypeOptional 
ctidTraderAccountIdint64Requiredトレーダーアカウントのユニークな識別子。トレーダーアカウントに対応する応答をマッチングするために使用されます。
positionIduint64Requiredポジションの一意のID。
usedMarginuint64Required使用されたマージンの新しい値。
moneyDigitsuint32Optional通貨値の指数を指定します。例:moneyDigits = 8は、ビジネス値を10^8倍して解釈する必要があります。その後、実際の値を得るために解釈された値を10^(-moneyDigits)で割ります。

ProtoOAMarginCheckEvent

新しいポジションが開かれたとき、または既存のポジションが変更されたときに送信されるマージンチェックイベント。

フィールドラベル説明
payloadTypeProtoOAPayloadTypeOptional 
ctidTraderAccountIdint64Requiredトレーダーアカウントのユニークな識別子。トレーダーアカウントに対応する応答をマッチングするために使用されます。
marginLeveldoubleRequired新しいマージンレベル。マージンレベルの値はパーセンテージで表されます。
marginLevelThresholddoubleRequired設定されたマージンレベル閾値。
marginCallAmountdoubleRequiredマージンコールの金額。
amountOfBaseMargindoubleRequired開かれたまたは変更されたポジションに割り当てられた基本マージン。
positionIduint64Required変更されたポジションの一意のID。
marginCheckTypeProtoOAMarginCheckTypeRequiredマージンチェックイベントのタイプ。以下のいずれかの値を取ります:OPEN_POSITION、UPDATE_POSITION。
moneyDigitsuint32Optional通貨値の指数を指定します。例:moneyDigits = 8は、ビジネス値を10^8倍して解釈する必要があります。その後、実際の値を得るために解釈された値を10^(-moneyDigits)で割ります。

ProtoOASymbolByIdRes

ProtoOASymbolByIdReq リクエストのレスポンス。

フィールドラベル説明
payloadTypeProtoOAPayloadTypeOptional 
ctidTraderAccountIdint64Requiredトレーダーアカウントのユニークな識別子。トレーダーアカウントに対応する応答をマッチングするために使用されます。
symbolRepeatedField<ProtoOASymbol>Repeated全てのフィールドを持つシンボルエンティティ。
archivedSymbolRepeatedField<ProtoOAArchivedSymbol>Repeatedアーカイブされたシンボル。

ProtoOASymbolCategoryListReq

トレーディングアカウントで利用可能なシンボルカテゴリのリストをリクエストします。

フィールドラベル説明
payloadTypeProtoOAPayloadTypeOptional 
ctidTraderAccountIdint64Requiredトレーダーアカウントのユニークな識別子。トレーダーアカウントに対応する応答をマッチングするために使用されます。

ProtoOASymbolCategoryListRes

ProtoSymbolCategoryListReq リクエストのレスポンス。

フィールドラベル説明
payloadTypeProtoOAPayloadTypeOptional 
ctidTraderAccountIdint64Requiredトレーダーアカウントのユニークな識別子。トレーダーアカウントに対応する応答をマッチングするために使用されます。
symbolCategoryRepeatedField<ProtoOASymbolCategory>Repeatedシンボルカテゴリのリスト。

ProtoOASymbolChangedEvent

サーバー側でシンボルが変更された際に送信されるイベント。

フィールドラベル説明
payloadTypeProtoOAPayloadTypeOptional 
ctidTraderAccountIdint64Requiredトレーダーアカウントのユニークな識別子。トレーダーアカウントに対応する応答をマッチングするために使用されます。
symbolIdRepeatedField<int64>RepeatedcTraderプラットフォーム上のシンボルのユニークな識別子。

ProtoOASymbolsForConversionReq

2つのアセット間の変換チェーンを取得するためのリクエスト。

直接のクォートが利用できない場合に使用します。

フィールドラベル説明
payloadTypeProtoOAPayloadTypeOptional 
ctidTraderAccountIdint64Requiredトレーダーアカウントのユニークな識別子。トレーダーアカウントに対応する応答をマッチングするために使用されます。
firstAssetIdint64Required変換チェーンの最初のアセットのID。例:EUR/USDの場合、firstAssetIdはEUR ID、lastAssetIdはUSD IDです。
lastAssetIdint64Required変換チェーンの最後のアセットのID。例:EUR/USDの場合、firstAssetIdはEUR ID、lastAssetIdはUSD IDです。

ProtoOASymbolsForConversionRes

ProtoOASymbolsForConversionReq リクエストのレスポンス。

フィールドラベル説明
payloadTypeProtoOAPayloadTypeOptional 
ctidTraderAccountIdint64Requiredトレーダーアカウントのユニークな識別子。トレーダーアカウントに対応する応答をマッチングするために使用されます。
symbolRepeatedField<ProtoOALightSymbol>Repeatedシンボルの変換チェーン(例:EUR/USD、USD/JPY、GBP/JPY -> EUR/GBP)。

ProtoOASymbolsListReq

トレーディングアカウントで利用可能なシンボルのリストをリクエストします。

シンボルのエントリは限られたフィールドのセットで返されます。

フィールドラベル説明
payloadTypeProtoOAPayloadTypeOptional 
ctidTraderAccountIdint64Requiredトレーダーアカウントのユニークな識別子。トレーダーアカウントに対応する応答をマッチングするために使用されます。
includeArchivedSymbolsboolOptional古いアーカイブされたシンボルをレスポンスに含めるかどうか。

ProtoOASymbolsListRes

ProtoOASymbolsListReq リクエストのレスポンス。

フィールドラベル説明
payloadTypeProtoOAPayloadTypeOptional 
ctidTraderAccountIdint64Requiredトレーダーアカウントのユニークな識別子。トレーダーアカウントに対応する応答をマッチングするために使用されます。
symbolRepeatedField<ProtoOALightSymbol>Repeatedシンボルのリスト。
archivedSymbolRepeatedField<ProtoOAArchivedSymbol>Repeatedアーカイブされたシンボルのリスト。

ProtoOATraderReq

トレーダーアカウントのデータを取得するためのリクエスト。

フィールドラベル説明
payloadTypeProtoOAPayloadTypeOptional 
ctidTraderAccountIdint64Requiredトレーダーアカウントのユニークな識別子。トレーダーアカウントに対応する応答をマッチングするために使用されます。

ProtoOATraderRes

ProtoOATraderReq リクエストへのレスポンス。

フィールドラベル説明
payloadTypeProtoOAPayloadTypeOptional 
ctidTraderAccountIdint64Requiredトレーダーアカウントのユニークな識別子。トレーダーアカウントに対応する応答をマッチングするために使用されます。
traderProtoOATraderRequiredトレーダーアカウント情報。

ProtoOATraderUpdatedEvent

サーバーサイドでトレーダーが更新されたときに送信されるイベント。

フィールドラベル説明
payloadTypeProtoOAPayloadTypeOptional 
ctidTraderAccountIdint64Requiredトレーダーアカウントのユニークな識別子。トレーダーアカウントに対応する応答をマッチングするために使用されます。
traderProtoOATraderRequiredトレーダーアカウント情報。

ProtoOATrailingSLChangedEvent

価格レベルの変更によってトレーリングストップロスのレベルが変更されたときに送信されるイベント。

フィールドラベル説明
payloadTypeProtoOAPayloadTypeOptional 
ctidTraderAccountIdint64Requiredトレーダーアカウントのユニークな識別子。トレーダーアカウントに対応する応答をマッチングするために使用されます。
positionIdint64RequiredポジションのユニークID。
orderIdint64Required注文のユニークID。
stopPricedoubleRequiredストップロス価格の新しい値。
utcLastUpdateTimestampint64Requiredストップロスが更新されたUnix時間(ミリ秒)。

ProtoOAUnsubscribeDepthQuotesReq

指定されたシンボルの市場の深さの購読を解除するリクエスト。

フィールドラベル説明
payloadTypeProtoOAPayloadTypeOptional 
ctidTraderAccountIdint64Requiredトレーダーアカウントのユニークな識別子。トレーダーアカウントに対応する応答をマッチングするために使用されます。
symbolIdRepeatedField<int64>Repeated解除する購読のシンボルIDのリスト。

ProtoOAUnsubscribeDepthQuotesRes

ProtoOAUnsubscribeDepthQuotesReq リクエストのレスポンス。

フィールドラベル説明
payloadTypeProtoOAPayloadTypeOptional 
ctidTraderAccountIdint64Requiredトレーダーアカウントのユニークな識別子。トレーダーアカウントに対応する応答をマッチングするために使用されます。
symbolIdRepeatedField<int64>Repeated解除された購読のシンボルIDのリスト。

ProtoOAUnsubscribeTicksReq

指定されたシンボルの市場のティックの購読を解除するリクエスト。

フィールドラベル説明
payloadTypeProtoOAPayloadTypeOptional 
ctidTraderAccountIdint64Requiredトレーダーアカウントのユニークな識別子。トレーダーアカウントに対応する応答をマッチングするために使用されます。
symbolIdRepeatedField<int64>Repeated解除する購読のシンボルIDのリスト。

ProtoOAUnsubscribeTicksRes

ProtoOAUnsubscribeTicksReq リクエストのレスポンス。

フィールドラベル説明
payloadTypeProtoOAPayloadTypeOptional 
ctidTraderAccountIdint64Requiredトレーダーアカウントのユニークな識別子。トレーダーアカウントに対応する応答をマッチングするために使用されます。
symbolIdRepeatedField<int64>Repeated解除された購読のシンボルIDのリスト。

ProtoOAUnsubscribeBarsReq

指定されたシンボルの市場のバーの購読を解除するリクエスト。

フィールドラベル説明
payloadTypeProtoOAPayloadTypeOptional 
ctidTraderAccountIdint64Requiredトレーダーアカウントのユニークな識別子。トレーダーアカウントに対応する応答をマッチングするために使用されます。
symbolIdRepeatedField<int64>Repeated解除する購読のシンボルIDのリスト。

ProtoOAUnsubscribeBarsRes

ProtoOAUnsubscribeBarsReq リクエストのレスポンス。

フィールドラベル説明
payloadTypeProtoOAPayloadTypeOptional 
ctidTraderAccountIdint64Requiredトレーダーアカウントのユニークな識別子。トレーダーアカウントに対応する応答をマッチングするために使用されます。
symbolIdRepeatedField<int64>Repeated解除された購読のシンボルIDのリスト。

このページについて