メッセージ

API

ProtoOAAccountAuthReq

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

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

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

ProtoOAAccountAuthRes

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

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

ProtoOAAccountDisconnectEvent

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

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

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

ProtoOAAccountLogoutReq

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

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

ProtoOAAccountLogoutRes

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

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

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

ProtoOAAccountsTokenInvalidatedEvent

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

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

ProtoOAAmendOrderReq

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

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

フィールド	型	ラベル	説明
payloadType	ProtoOAPayloadType	オプション
ctidTraderAccountId	int64	必須	トレーダーアカウントの一意の識別子。応答をトレーダーアカウントに一致させるために使用されます。
orderId	int64	必須	注文の一意のID。
volume	int64	オプション	ボリューム、0.01単位で表されます（例: セント）。
limitPrice	double	オプション	リミット価格、LIMIT注文の場合に指定できます。
stopPrice	double	オプション	ストップ価格、STOP注文の場合に指定できます。
expirationTimestamp	int64	オプション	時間のUNIXタイムスタンプ、注文が無効になる日時。
slTpMode	ProtoOASlTpMode	オプション	停止損失と利益の取得の注文モード、利用可能なモードについては: OASlTpMode 。
sl	double	オプション	停止損失、STOPおよびMARKET_RANGE注文で利用可能。
tp	double	オプション	利益の取得、STOPおよびMARKET_RANGE注文で利用可能。
comment	string	オプション	注文に関する追加のコメント。

ProtoOAAmendOrderRes

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

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

フィールド	型	ラベル	説明
payloadType	ProtoOAPayloadType	オプション
errorCode	ProtoOAAmendOrderErrorCode	オプション
errorMessage	string	オプション	注文変更が失敗した理由。失敗しなかった場合は未定義です。

ProtoOAAmendOrderErrorCode

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

名前	番号	説明
ORDER_NOT_FOUND	1	指定されたIDの注文が見つかりません。
INVALID_NEW_ORDER	2	新しい注文情報が無効です。
INVALID_ORDER_ID	3	注文IDが無効です。
INTERNAL_SERVER_ERROR	4	内部サーバーエラー。
TRADE_DISABLED	5	トレードが無効になっています。

ProtoOATradeServerTokenInvalidatedEvent

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

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

ProtoOAGetCTIDProfileImageURLReq

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

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

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

ProtoOAGetCTIDProfileImageURLRes

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

フィールド	型	ラベル	説明
payloadType	ProtoOAPayloadType	オプション
profileImageUrl	string	必須	プロフィール画像のURL。

ProtoOADealListRes

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

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	Optional
ctidTraderAccountId	int64	Required	トレーダーアカウントの一意の識別子。応答をトレーダーアカウントに一致させるために使用されます。
deal	RepeatedField<ProtoOADeal>	Repeated	取引のリスト。
hasMore	bool	Required	TRUEの場合、フィルターによるレコード数がchunkSizeよりも大きい場合、応答にはchunkSizeと同じ数のレコードが含まれます。

ProtoOADealOffsetListReq

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

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	Optional
ctidTraderAccountId	int64	Required	トレーダーアカウントの一意の識別子。応答をトレーダーアカウントに一致させるために使用されます。
dealId	int64	Required	取引の一意のID。

ProtoOADealOffsetListRes

ProtoOADealOffsetListReqの応答です。

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	Optional
ctidTraderAccountId	int64	Required	トレーダーアカウントの一意の識別子。応答をトレーダーアカウントに一致させるために使用されます。
offsetBy	RepeatedField<ProtoOADealOffset>	Repeated	指定された取引を閉じた取引。
offsetting	RepeatedField<ProtoOADealOffset>	Repeated	指定された取引によって閉じられた取引。

ProtoOADepthEvent

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

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

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	Optional
ctidTraderAccountId	int64	Required	トレーダーアカウントの一意の識別子。応答をトレーダーアカウントに一致させるために使用されます。
symbolId	uint64	Required	cTraderプラットフォーム内のシンボルの一意の識別子。
newQuotes	RepeatedField<ProtoOADepthQuote>	Repeated	市場の深さの見積もりの変更のリスト。
deletedQuotes	RepeatedField<uint64>	Repeated	削除する見積もりのリスト。

ProtoOAErrorRes

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

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	Optional
ctidTraderAccountId	int64	Required	トレーダーアカウントの一意の識別子。応答をトレーダーアカウントに一致させるために使用されます。
error	ProtoOAError	Optional	エラーの詳細。

ProtoOAGetTrendbarsRes

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

フィールド	タイプ	ラベル	説明
payloadType	ProtoOAPayloadType	オプション
ctidTraderAccountId	int64	必須	トレーダーのアカウントの一意の識別子。レスポンスをトレーダーのアカウントに一致させるために使用されます。
period	ProtoOATrendbarPeriod	必須	トレンドバーのシリーズの期間を指定します（例：M1、M10など）。
timestamp	int64	オプション	このフィールドを使用しないでください。元のリクエストにはすでにtoTimestampが含まれています。
trendbar	RepeatedField<ProtoOATrendbar>	繰り返し	トレンドバーのリスト。
symbolId	int64	オプション	cTraderプラットフォームのシンボルの一意の識別子。
hasMore	bool	オプション	TRUEの場合、フィルターによるレコード数がchunkSizeよりも大きい場合、レスポンスにはchunkSizeと同じ数のレコードが含まれます。

ProtoOAMarginCallListReq

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

フィールド	タイプ	ラベル	説明
payloadType	ProtoOAPayloadType	オプション
ctidTraderAccountId	int64	必須

ProtoOAMarginCallListRes

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

フィールド	タイプ	ラベル	説明
payloadType	ProtoOAPayloadType	オプション
marginCall	RepeatedField<ProtoOAMarginCall>	繰り返し

ProtoOAMarginCallTriggerEvent

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

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

ProtoOAMarginCallUpdateEvent

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

フィールド	型	ラベル
payloadType	ProtoOAPayloadType	Optional
ctidTraderAccountId	int64	Required
marginCall	ProtoOAMarginCall	Required

ProtoOAMarginCallUpdateReq

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

フィールド	型	ラベル
payloadType	ProtoOAPayloadType	Optional
ctidTraderAccountId	int64	Required
marginCall	ProtoOAMarginCall	Required

ProtoOAMarginCallUpdateRes

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

フィールド	型	ラベル	説明
payloadType	ProtoOAPayloadType	Optional

ProtoOAMarginChangedEvent

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

フィールド	型	ラベル	説明
payloadType	ProtoOAPayloadType	Optional
ctidTraderAccountId	int64	Required	トレーダーアカウントのユニークな識別子。トレーダーアカウントに対応する応答をマッチングするために使用されます。
positionId	uint64	Required	ポジションの一意のID。
usedMargin	uint64	Required	使用されたマージンの新しい値。
moneyDigits	uint32	Optional	通貨値の指数を指定します。例：moneyDigits = 8は、ビジネス値を10^8倍して解釈する必要があります。その後、実際の値を得るために解釈された値を10^（-moneyDigits）で割ります。

ProtoOAMarginCheckEvent

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

フィールド	型	ラベル	説明
payloadType	ProtoOAPayloadType	Optional
ctidTraderAccountId	int64	Required	トレーダーアカウントのユニークな識別子。トレーダーアカウントに対応する応答をマッチングするために使用されます。
marginLevel	double	Required	新しいマージンレベル。マージンレベルの値はパーセンテージで表されます。
marginLevelThreshold	double	Required	設定されたマージンレベル閾値。
marginCallAmount	double	Required	マージンコールの金額。
amountOfBaseMargin	double	Required	開かれたまたは変更されたポジションに割り当てられた基本マージン。
positionId	uint64	Required	変更されたポジションの一意のID。
marginCheckType	ProtoOAMarginCheckType	Required	マージンチェックイベントのタイプ。以下のいずれかの値を取ります：OPEN_POSITION、UPDATE_POSITION。
moneyDigits	uint32	Optional	通貨値の指数を指定します。例：moneyDigits = 8は、ビジネス値を10^8倍して解釈する必要があります。その後、実際の値を得るために解釈された値を10^（-moneyDigits）で割ります。

ProtoOASymbolByIdRes

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

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

ProtoOASymbolCategoryListReq

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

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

ProtoOASymbolCategoryListRes

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

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

ProtoOASymbolChangedEvent

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

フィールド	型	ラベル	説明
payloadType	ProtoOAPayloadType	Optional
ctidTraderAccountId	int64	Required	トレーダーアカウントのユニークな識別子。トレーダーアカウントに対応する応答をマッチングするために使用されます。
symbolId	RepeatedField<int64>	Repeated	cTraderプラットフォーム上のシンボルのユニークな識別子。

ProtoOASymbolsForConversionReq

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

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

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

ProtoOASymbolsForConversionRes

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

フィールド	型	ラベル	説明
payloadType	ProtoOAPayloadType	Optional
ctidTraderAccountId	int64	Required	トレーダーアカウントのユニークな識別子。トレーダーアカウントに対応する応答をマッチングするために使用されます。
symbol	RepeatedField<ProtoOALightSymbol>	Repeated	シンボルの変換チェーン（例：EUR/USD、USD/JPY、GBP/JPY -> EUR/GBP）。

ProtoOASymbolsListReq

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

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

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

ProtoOASymbolsListRes

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

フィールド	型	ラベル	説明
payloadType	ProtoOAPayloadType	Optional
ctidTraderAccountId	int64	Required	トレーダーアカウントのユニークな識別子。トレーダーアカウントに対応する応答をマッチングするために使用されます。
symbol	RepeatedField<ProtoOALightSymbol>	Repeated	シンボルのリスト。
archivedSymbol	RepeatedField<ProtoOAArchivedSymbol>	Repeated	アーカイブされたシンボルのリスト。

ProtoOATraderReq

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

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

ProtoOATraderRes

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

フィールド	型	ラベル	説明
payloadType	ProtoOAPayloadType	Optional
ctidTraderAccountId	int64	Required	トレーダーアカウントのユニークな識別子。トレーダーアカウントに対応する応答をマッチングするために使用されます。
trader	ProtoOATrader	Required	トレーダーアカウント情報。

ProtoOATraderUpdatedEvent

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

フィールド	型	ラベル	説明
payloadType	ProtoOAPayloadType	Optional
ctidTraderAccountId	int64	Required	トレーダーアカウントのユニークな識別子。トレーダーアカウントに対応する応答をマッチングするために使用されます。
trader	ProtoOATrader	Required	トレーダーアカウント情報。

ProtoOATrailingSLChangedEvent

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

フィールド	型	ラベル	説明
payloadType	ProtoOAPayloadType	Optional
ctidTraderAccountId	int64	Required	トレーダーアカウントのユニークな識別子。トレーダーアカウントに対応する応答をマッチングするために使用されます。
positionId	int64	Required	ポジションのユニークID。
orderId	int64	Required	注文のユニークID。
stopPrice	double	Required	ストップロス価格の新しい値。
utcLastUpdateTimestamp	int64	Required	ストップロスが更新されたUnix時間（ミリ秒）。

ProtoOAUnsubscribeDepthQuotesReq

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

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

ProtoOAUnsubscribeDepthQuotesRes

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

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

ProtoOAUnsubscribeTicksReq

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

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

ProtoOAUnsubscribeTicksRes

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

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

ProtoOAUnsubscribeBarsReq

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

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

ProtoOAUnsubscribeBarsRes

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

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