References

You can find all API proto objects and their memebrs description here.

Top

OpenApiCommonMessages

ProtoErrorRes

Field	Type	Label	Description
payloadType	ProtoPayloadType	optional	Default: ERROR_RES
errorCode	string	required	Contains name of ProtoErrorCode or other custom ErrorCodes (e.g. ProtoCHErrorCode)
description	string	optional	Error description
maintenanceEndTimestamp	uint64	optional	CS-10489 Epoch timestamp in second

ProtoHeartbeatEvent

Event that is sent from Open API proxy and can be used as criteria that connection is healthy when no other messages are sent by cTrader platform. Open API client can send this message when he needs to keep the connection open for a period without other messages longer than 30 seconds

Field	Type	Label	Description
payloadType	ProtoPayloadType	optional	Default: HEARTBEAT_EVENT

ProtoMessage

Field	Type	Label	Description
payloadType	uint32	required	Contains id of ProtoPayloadType or other custom PayloadTypes (e.g. ProtoOAPayloadType)
payload	bytes	optional	Serialized protobuf message that corresponds to payloadType
clientMsgId	string	optional	Request message id, assigned by the client that will be returned in the response

Top

OpenApiCommonModelMessages

ProtoErrorCode

COMMON error codes 1 - 99

Name	Number	Description
UNKNOWN_ERROR	1	Generic error.
UNSUPPORTED_MESSAGE	2	Message is not supported. Wrong message.
INVALID_REQUEST	3	Generic error. Usually used when input value is not correct.
TIMEOUT_ERROR	5	Deal execution is reached timeout and rejected.
ENTITY_NOT_FOUND	6	Generic error for requests by id.
CANT_ROUTE_REQUEST	7	Connection to Server is lost or not supported.
FRAME_TOO_LONG	8	Message is too large.
MARKET_CLOSED	9	Market is closed.
CONCURRENT_MODIFICATION	10	Order is blocked (e.g. under execution) and change cannot be applied.
BLOCKED_PAYLOAD_TYPE	11	Message is blocked by server.

ProtoPayloadType

--- INTENSIVE COMMANDS 1 - 49 --- COMMON API 50 - 69

Name	Number	Description
PROTO_MESSAGE	5	common intensive
ERROR_RES	50	common commands
HEARTBEAT_EVENT	51

Top

OpenApiMessages

ProtoOAAccountAuthReq

Request for the authorizing trading account session. Requires established authorized connection with the client application using ProtoOAApplicationAuthReq.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_ACCOUNT_AUTH_REQ
ctidTraderAccountId	int64	required	The unique identifier of the trader's account in cTrader platform.
accessToken	string	required	The Access Token issued for providing access to the Trader's Account.

ProtoOAAccountAuthRes

Response to the ProtoOAApplicationAuthRes request.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_ACCOUNT_AUTH_RES
ctidTraderAccountId	int64	required	The unique identifier of the trader's account in cTrader platform.

ProtoOAAccountDisconnectEvent

Event that is sent when the established session for an account is dropped on the server side. A new session must be authorized for the account.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_ACCOUNT_DISCONNECT_EVENT
ctidTraderAccountId	int64	required	The unique identifier of the trader's account in cTrader platform.

ProtoOAAccountLogoutReq

Request for logout of trading account session.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_ACCOUNT_LOGOUT_REQ
ctidTraderAccountId	int64	required	The unique identifier of the trader's account in cTrader platform.

ProtoOAAccountLogoutRes

Response to the ProtoOATraderLogoutReq request.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_ACCOUNT_LOGOUT_RES
ctidTraderAccountId	int64	required	The unique identifier of the trader's account in cTrader platform.

ProtoOAAccountsTokenInvalidatedEvent

Event that is sent when a session to a specific trader's account is terminated by the server but the existing connections with the other trader's accounts are maintained.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_ACCOUNTS_TOKEN_INVALIDATED_EVENT
ctidTraderAccountIds	int64	repeated	The unique identifier of the trader's account in cTrader platform.
reason	string	optional	The disconnection reason explained. For example: Access Token is expired or recalled.

ProtoOAAmendOrderReq

Request for amending the existing pending order. Allowed only if the Access Token has "trade" permissions for the trading account.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_AMEND_ORDER_REQ
ctidTraderAccountId	int64	required	Unique identifier of the trader's account. Used to match responses to trader's accounts.
orderId	int64	required	The unique ID of the order.
volume	int64	optional	Volume, represented in 0.01 of a unit (e.g. cents).
limitPrice	double	optional	The Limit Price, can be specified for the LIMIT order only.
stopPrice	double	optional	The Stop Price, can be specified for the STOP and the STOP_LIMIT orders.
expirationTimestamp	int64	optional	The exact Order expiration time. Should be set for the Good Till Date orders.
stopLoss	double	optional	The absolute Stop Loss price (e.g. 1.23456). Not supported for the MARKER orders.
takeProfit	double	optional	The absolute Take Profit price (e.g. 1.23456). Not supported for the MARKER orders.
slippageInPoints	int32	optional	Slippage distance for the MARKET_RANGE and the STOP_LIMIT orders.
relativeStopLoss	int64	optional	The relative Stop Loss can be specified instead of the absolute one. Specified in 1/100000 of a unit of price. For BUY stopLoss = entryPrice - relativeStopLoss, for SELL stopLoss = entryPrice + relativeStopLoss.
relativeTakeProfit	int64	optional	The relative Take Profit can be specified instead of the absolute one. Specified in 1/100000 of a unit of price. For BUY takeProfit = entryPrice + relativeTakeProfit, for SELL takeProfit = entryPrice - relativeTakeProfit.
guaranteedStopLoss	bool	optional	If TRUE then the Stop Loss is guaranteed. Available for the French Risk or the Guaranteed Stop Loss Accounts.
trailingStopLoss	bool	optional	If TRUE then the Trailing Stop Loss is applied.
stopTriggerMethod	ProtoOAOrderTriggerMethod	optional	Trigger method for the STOP or the STOP_LIMIT pending order. Default: TRADE

ProtoOAAmendPositionSLTPReq

Request for amending StopLoss and TakeProfit of existing position. Allowed only if the accessToken has "trade" permissions for the trading account.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_AMEND_POSITION_SLTP_REQ
ctidTraderAccountId	int64	required	Unique identifier of the trader's account. Used to match responses to trader's accounts.
positionId	int64	required	The unique ID of the position to amend.
stopLoss	double	optional	Absolute Stop Loss price (1.23456 for example).
takeProfit	double	optional	Absolute Take Profit price (1.26543 for example).
guaranteedStopLoss	bool	optional	If TRUE then the Stop Loss is guaranteed. Available for the French Risk or the Guaranteed Stop Loss Accounts.
trailingStopLoss	bool	optional	If TRUE then the Trailing Stop Loss is applied.
stopLossTriggerMethod	ProtoOAOrderTriggerMethod	optional	The Stop trigger method for the Stop Loss/Take Profit order. Default: TRADE

ProtoOAApplicationAuthReq

Request for the authorizing an application to work with the cTrader platform Proxies.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_APPLICATION_AUTH_REQ
clientId	string	required	The unique Client ID provided during the registration.
clientSecret	string	required	The unique Client Secret provided during the registration.

ProtoOAApplicationAuthRes

Response to the ProtoOAApplicationAuthReq request.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_APPLICATION_AUTH_RES

ProtoOAAssetClassListReq

Request for a list of asset classes available for the trader's account.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_ASSET_CLASS_LIST_REQ
ctidTraderAccountId	int64	required	Unique identifier of the trader's account. Used to match responses to trader's accounts.

ProtoOAAssetClassListRes

Response to the ProtoOAAssetListReq request.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_ASSET_CLASS_LIST_RES
ctidTraderAccountId	int64	required	Unique identifier of the trader's account. Used to match responses to trader's accounts.
assetClass	ProtoOAAssetClass	repeated	List of the asset classes.

ProtoOAAssetListReq

Request for the list of assets available for a trader's account.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_ASSET_LIST_REQ
ctidTraderAccountId	int64	required	Unique identifier of the trader's account. Used to match responses to trader's accounts.

ProtoOAAssetListRes

Response to the ProtoOAAssetListReq request.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_ASSET_LIST_RES
ctidTraderAccountId	int64	required	Unique identifier of the trader's account. Used to match responses to trader's accounts.
asset	ProtoOAAsset	repeated	The list of assets.

ProtoOACancelOrderReq

Request for cancelling existing pending order. Allowed only if the accessToken has "trade" permissions for the trading account.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_CANCEL_ORDER_REQ
ctidTraderAccountId	int64	required	Unique identifier of the trader's account. Used to match responses to trader's accounts.
orderId	int64	required	The unique ID of the order.

ProtoOACashFlowHistoryListReq

Request for getting Trader's historical data of deposits and withdrawals.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_CASH_FLOW_HISTORY_LIST_REQ
ctidTraderAccountId	int64	required	Unique identifier of the trader's account. Used to match responses to trader's accounts.
fromTimestamp	int64	required	The UNIX time from which the search starts >=0 (1-1-1970). Validation: toTimestamp - fromTimestamp <= 604800000 (1 week).
toTimestamp	int64	required	The UNIX time where to stop searching <= 2147483646000 (19-1-2038).

ProtoOACashFlowHistoryListRes

Response to the ProtoOACashFlowHistoryListReq request.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_CASH_FLOW_HISTORY_LIST_RES
ctidTraderAccountId	int64	required	Unique identifier of the trader's account. Used to match responses to trader's accounts.
depositWithdraw	ProtoOADepositWithdraw	repeated	The list of deposit and withdrawal operations.

ProtoOAClientDisconnectEvent

Event that is sent when the connection with the client application is cancelled by the server. All the sessions for the traders' accounts will be terminated.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_CLIENT_DISCONNECT_EVENT
reason	string	optional	The disconnection reason explained. For example: The application access was blocked by cTrader Administrator.

ProtoOAClosePositionReq

Request for closing or partially closing of an existing position. Allowed only if the accessToken has "trade" permissions for the trading account.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_CLOSE_POSITION_REQ
ctidTraderAccountId	int64	required	Unique identifier of the trader's account. Used to match responses to trader's accounts.
positionId	int64	required	The unique ID of the position to close.
volume	int64	required	Volume to close, represented in 0.01 of a unit (e.g. cents).

ProtoOADealListReq

Request for getting Trader's deals historical data (execution details).

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_DEAL_LIST_REQ
ctidTraderAccountId	int64	required	Unique identifier of the trader's account. Used to match responses to trader's accounts.
fromTimestamp	int64	required	The UNIX time from which the search starts >=0 (1-1-1970). Validation: toTimestamp - fromTimestamp <= 604800000 (1 week).
toTimestamp	int64	required	The UNIX time where to stop searching <= 2147483646000 (19-1-2038).
maxRows	int32	optional	The maximum number of the deals to return.

ProtoOADealListRes

The response to the ProtoOADealListRes request.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_DEAL_LIST_RES
ctidTraderAccountId	int64	required	Unique identifier of the trader's account. Used to match responses to trader's accounts.
deal	ProtoOADeal	repeated	The list of the deals.
hasMore	bool	required	If TRUE then the response will provide more than 10000 deals.

ProtoOADepthEvent

Event that is sent when the structure of depth of market is changed. Requires subscription on the depth of markets for the symbol, see ProtoOASubscribeDepthQuotesReq.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_DEPTH_EVENT
ctidTraderAccountId	int64	required	Unique identifier of the trader's account. Used to match responses to trader's accounts.
symbolId	uint64	required	Unique identifier of the Symbol in cTrader platform.
newQuotes	ProtoOADepthQuote	repeated	The list of changes in the depth of market quotes.
deletedQuotes	uint64	repeated	The list of quotes to delete.

ProtoOAErrorRes

Generic response when an ERROR occurred.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_ERROR_RES
ctidTraderAccountId	int64	optional	The unique identifier of the trader's account in cTrader platform.
errorCode	string	required	The name of the ProtoErrorCode or the other custom ErrorCodes (e.g. ProtoCHErrorCode).
description	string	optional	The error description.
maintenanceEndTimestamp	int64	optional	The timestamp in seconds when the current maintenance session will be ended.

ProtoOAExecutionEvent

Event that is sent following the successful order acceptance or execution by the server. Acts as response to the ProtoOANewOrderReq, ProtoOACancelOrderReq, ProtoOAAmendOrderReq, ProtoOAAmendPositionSLTPReq, ProtoOAClosePositionReq requests. Also, the event is sent when a Deposit/Withdrawal took place.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_EXECUTION_EVENT
ctidTraderAccountId	int64	required	Unique identifier of the trader's account. Used to match responses to trader's accounts.
executionType	ProtoOAExecutionType	required	Type of the order operation. For example: ACCEPTED, FILLED, etc.
position	ProtoOAPosition	optional	Reference to the position linked with the execution
order	ProtoOAOrder	optional	Reference to the initial order.
deal	ProtoOADeal	optional	Reference to the deal (execution).
bonusDepositWithdraw	ProtoOABonusDepositWithdraw	optional	Reference to the Bonus Deposit or Withdrawal operation.
depositWithdraw	ProtoOADepositWithdraw	optional	Reference to the Deposit or Withdrawal operation.
errorCode	string	optional	The name of the ProtoErrorCode or the other custom ErrorCodes (e.g. ProtoCHErrorCode).
isServerEvent	bool	optional	If TRUE then the event generated by the server logic instead of the trader's request. (e.g. stop-out).

ProtoOAExpectedMarginReq

Request for getting the margin estimate. Can be used before sending a new order request.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_EXPECTED_MARGIN_REQ
ctidTraderAccountId	int64	required	Unique identifier of the trader's account. Used to match responses to trader's accounts.
symbolId	int64	required	Unique identifier of the Symbol in cTrader platform.
volume	int64	repeated	Volume represented in 0.01 of a unit (e.g. cents).

ProtoOAExpectedMarginRes

The response to the ProtoOAExpectedMarginReq request.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_EXPECTED_MARGIN_RES
ctidTraderAccountId	int64	required	Unique identifier of the trader's account. Used to match responses to trader's accounts.
margin	ProtoOAExpectedMargin	repeated	The buy and sell margin estimate.
moneyDigits	uint32	optional	Specifies the exponent of the monetary values. E.g. moneyDigits = 8 must be interpret as business value multiplied by 10^8, then real balance would be 10053099944 / 10^8 = 100.53099944. Affects margin.buyMargin, margin.sellMargin.

ProtoOAGetAccountListByAccessTokenReq

Request for getting the list of granted trader's account for the access token.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_GET_ACCOUNTS_BY_ACCESS_TOKEN_REQ
accessToken	string	required	The Access Token issued for providing access to the Trader's Account.

ProtoOAGetAccountListByAccessTokenRes

Response to the ProtoOAGetAccountListByAccessTokenReq request.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_GET_ACCOUNTS_BY_ACCESS_TOKEN_RES
accessToken	string	required	The Access Token issued for providing access to the Trader's Account.
permissionScope	ProtoOAClientPermissionScope	optional	SCOPE_VIEW, SCOPE_TRADE.
ctidTraderAccount	ProtoOACtidTraderAccount	repeated	The list of the accounts.

ProtoOAGetCtidProfileByTokenReq

Request for getting details of Trader's profile. Limited due to GDRP requirements.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_GET_CTID_PROFILE_BY_TOKEN_REQ
accessToken	string	required	The Access Token issued for providing access to the Trader's Account.

ProtoOAGetCtidProfileByTokenRes

Response to the ProtoOAGetCtidProfileByTokenReq request.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_GET_CTID_PROFILE_BY_TOKEN_RES
profile	ProtoOACtidProfile	required	Trader's profile.

ProtoOAGetTickDataReq

Request for getting historical tick data for the symbol.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_GET_TICKDATA_REQ
ctidTraderAccountId	int64	required	Unique identifier of the trader's account. Used to match responses to trader's accounts.
symbolId	int64	required	Unique identifier of the Symbol in cTrader platform.
type	ProtoOAQuoteType	required	Bid/Ask (1/2).
fromTimestamp	int64	required	The exact time of starting the search in milliseconds. Must be bigger of equal to zero (1-1-1970). Validation: toTimestamp - fromTimestamp <= 604800000 (1 week).
toTimestamp	int64	required	The exact time of finishing the search in milliseconds <= 2147483646000 (19-1-2038).

ProtoOAGetTickDataRes

Response to the ProtoOAGetTickDataReq request.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_GET_TICKDATA_RES
ctidTraderAccountId	int64	required	Unique identifier of the trader's account. Used to match responses to trader's accounts.
tickData	ProtoOATickData	repeated	The list of ticks.
hasMore	bool	required	If TRUE then the number of records by filter is larger than chunkSize, the response contains the number of records that is equal to chunkSize.

ProtoOAGetTrendbarsReq

Request for getting historical trend bars for the symbol.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_GET_TRENDBARS_REQ
ctidTraderAccountId	int64	required	Unique identifier of the trader's account. Used to match responses to trader's accounts.
fromTimestamp	int64	required	The exact time of starting the search in milliseconds. Must be bigger or equal to zero (1-1-1970). Validation: toTimestamp - fromTimestamp <= X, where X depends on series period: M1, M2, M3, M4, M5: 302400000 (5 weeks); M10, M15, M30, H1: 21168000000 (35 weeks), H4, H12, D1: 31622400000 (1 year); W1, MN1: 158112000000 (5 years).
toTimestamp	int64	required	The exact time of finishing the search in milliseconds. Smaller or equal to 2147483646000 (19-1-2038).
period	ProtoOATrendbarPeriod	required	Specifies period of trend bar series (e.g. M1, M10, etc.).
symbolId	int64	required	Unique identifier of the Symbol in cTrader platform.

ProtoOAGetTrendbarsRes

Response to the ProtoOAGetTrendbarsReq request.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_GET_TRENDBARS_RES
ctidTraderAccountId	int64	required	Unique identifier of the trader's account. Used to match responses to trader's accounts.
period	ProtoOATrendbarPeriod	required	Specifies period of trend bar series (e.g. M1, M10, etc.).
timestamp	int64	required	Equals to toTimestamp from the request.
trendbar	ProtoOATrendbar	repeated	The list of trend bars.
symbolId	int64	optional	Unique identifier of the Symbol in cTrader platform.

ProtoOAMarginCallListReq

Request for a list of existing margin call thresholds configured for a user.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_MARGIN_CALL_LIST_REQ
ctidTraderAccountId	int64	required

ProtoOAMarginCallListRes

Response with a list of existing user Margin Calls, usually contains 3 items.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_MARGIN_CALL_LIST_RES
marginCall	ProtoOAMarginCall	repeated

ProtoOAMarginCallTriggerEvent

Event that is sent when account margin level reaches target marginLevelThreshold. Event is sent no more than once every 10 minutes to avoid spamming.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_MARGIN_CALL_TRIGGER_EVENT
ctidTraderAccountId	int64	required
marginCall	ProtoOAMarginCall	required

ProtoOAMarginCallUpdateEvent

Event that is sent when a Margin Call threshold configuration is updated.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_MARGIN_CALL_UPDATE_EVENT
ctidTraderAccountId	int64	required
marginCall	ProtoOAMarginCall	required

ProtoOAMarginCallUpdateReq

Request to modify marginLevelThreshold of specified marginCallType for ctidTraderAccountId.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_MARGIN_CALL_UPDATE_REQ
ctidTraderAccountId	int64	required
marginCall	ProtoOAMarginCall	required

ProtoOAMarginCallUpdateRes

If this response received, it means that margin call was successfully updated.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_MARGIN_CALL_UPDATE_RES

ProtoOAMarginChangedEvent

Event that is sent when the margin allocated to a specific position is changed.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_MARGIN_CHANGED_EVENT
ctidTraderAccountId	int64	required	Unique identifier of the trader's account. Used to match responses to trader's accounts.
positionId	uint64	required	The unique ID of the position.
usedMargin	uint64	required	The new value of the margin used.
moneyDigits	uint32	optional	Specifies the exponent of the monetary values. E.g. moneyDigits = 8 must be interpret as business value multiplied by 10^8, then real balance would be 10053099944 / 10^8 = 100.53099944. Affects usedMargin.

ProtoOANewOrderReq

Request for sending a new trading order. Allowed only if the accessToken has the "trade" permissions for the trading account.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_NEW_ORDER_REQ
ctidTraderAccountId	int64	required	The unique identifier of the trader's account in cTrader platform.
symbolId	int64	required	The unique identifier of a symbol in cTrader platform.
orderType	ProtoOAOrderType	required	The type of an order - MARKET, LIMIT, STOP, MARKET_RANGE, STOP_LIMIT.
tradeSide	ProtoOATradeSide	required	The trade direction - BUY or SELL.
volume	int64	required	The volume represented in 0.01 of a unit (e.g. US$ 10.00 = 1000).
limitPrice	double	optional	The limit price, can be specified for the LIMIT order only.
stopPrice	double	optional	Stop Price, can be specified for the STOP and the STOP_LIMIT orders only.
timeInForce	ProtoOATimeInForce	optional	The specific order execution or expiration instruction - GOOD_TILL_DATE, GOOD_TILL_CANCEL, IMMEDIATE_OR_CANCEL, FILL_OR_KILL, MARKET_ON_OPEN. Default: GOOD_TILL_CANCEL
expirationTimestamp	int64	optional	The exact Order expiration time. Should be set for the Good Till Date orders.
stopLoss	double	optional	The absolute Stop Loss price (1.23456 for example). Not supported for the MARKER orders.
takeProfit	double	optional	The absolute Take Profit price (1.23456 for example). Unsupported for the MARKER orders.
comment	string	optional	User-specified comment. MaxLength = 512.
baseSlippagePrice	double	optional	Base price to calculate relative slippage price for MARKET_RANGE order.
slippageInPoints	int32	optional	Slippage distance for MARKET_RANGE and STOP_LIMIT order.
label	string	optional	User-specified label. MaxLength = 100.
positionId	int64	optional	Reference to the existing position if the Order is intended to modify it.
clientOrderId	string	optional	Optional user-specific clientOrderId (similar to FIX ClOrderID). MaxLength = 50.
relativeStopLoss	int64	optional	Relative Stop Loss that can be specified instead of the absolute as one. Specified in 1/100000 of unit of a price. For BUY stopLoss = entryPrice - relativeStopLoss, for SELL stopLoss = entryPrice + relativeStopLoss.
relativeTakeProfit	int64	optional	Relative Take Profit that can be specified instead of the absolute one. Specified in 1/100000 of unit of a price. For BUY takeProfit = entryPrice + relativeTakeProfit, for SELL takeProfit = entryPrice - relativeTakeProfit.
guaranteedStopLoss	bool	optional	If TRUE then stopLoss is guaranteed. Available for the French Risk or the Guaranteed Stop Loss Accounts.
trailingStopLoss	bool	optional	If TRUE then the Stop Loss is Trailing.
stopTriggerMethod	ProtoOAOrderTriggerMethod	optional	Trigger method for the STOP or the STOP_LIMIT pending order. Default: TRADE

ProtoOAOrderErrorEvent

Event that is sent when errors occur during the order requests.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_ORDER_ERROR_EVENT
ctidTraderAccountId	int64	required	Unique identifier of the trader's account. Used to match responses to trader's accounts.
errorCode	string	required	The name of the ProtoErrorCode or the other custom ErrorCodes (e.g. ProtoCHErrorCode).
orderId	int64	optional	The unique ID of the order.
positionId	int64	optional	The unique ID of the position.
description	string	optional	The error description.

ProtoOAReconcileReq

Request for getting Trader's current open positions and pending orders data.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_RECONCILE_REQ
ctidTraderAccountId	int64	required	Unique identifier of the trader's account. Used to match responses to trader's accounts.

ProtoOAReconcileRes

The response to the ProtoOAReconcileReq request.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_RECONCILE_RES
ctidTraderAccountId	int64	required	Unique identifier of the trader's account. Used to match responses to trader's accounts.
position	ProtoOAPosition	repeated	The list of trader's account open positions.
order	ProtoOAOrder	repeated	The list of trader's account pending orders.

ProtoOARefreshTokenReq

Request to refresh the access token using refresh token of granted trader's account.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_REFRESH_TOKEN_REQ
refreshToken	string	required	The Refresh Token issued for updating Access Token.

ProtoOARefreshTokenRes

Response to the ProtoOARefreshTokenReq request.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_REFRESH_TOKEN_RES
accessToken	string	required	The Access Token issued for providing access to the Trader's Account.
tokenType	string	required	bearer
expiresIn	int64	required	Access Token expiration in seconds
refreshToken	string	required

ProtoOASpotEvent

Event that is sent when a new spot event is generated on the server side. Requires subscription on the spot events, see ProtoOASubscribeSpotsReq.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_SPOT_EVENT
ctidTraderAccountId	int64	required	Unique identifier of the trader's account. Used to match responses to trader's accounts.
symbolId	int64	required	Unique identifier of the Symbol in cTrader platform.
bid	uint64	optional	Bid price. Specified in 1/100_000 of unit of a price. (e.g. 1.23 -> 123_000)
ask	uint64	optional	Ask price. Specified in 1/100_000 of unit of a price.
trendbar	ProtoOATrendbar	repeated	Returns live trend bar. Requires subscription on the trend bars.
sessionClose	uint64	optional	Last session close. Specified in 1/100_000 of unit of a price.

ProtoOASubscribeDepthQuotesReq

Request for subscribing on depth of market of the specified symbol.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_SUBSCRIBE_DEPTH_QUOTES_REQ
ctidTraderAccountId	int64	required	Unique identifier of the trader's account. Used to match responses to trader's accounts.
symbolId	int64	repeated	Unique identifier of the Symbol in cTrader platform.

ProtoOASubscribeDepthQuotesRes

Response to the ProtoOASubscribeDepthQuotesReq request.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_SUBSCRIBE_DEPTH_QUOTES_RES
ctidTraderAccountId	int64	required	Unique identifier of the trader's account. Used to match responses to trader's accounts.

ProtoOASubscribeLiveTrendbarReq

Request for subscribing for live trend bars. Requires subscription on the spot events, see ProtoOASubscribeSpotsReq.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_SUBSCRIBE_LIVE_TRENDBAR_REQ
ctidTraderAccountId	int64	required	Unique identifier of the trader's account. Used to match responses to trader's accounts.
period	ProtoOATrendbarPeriod	required	Specifies period of trend bar series (e.g. M1, M10, etc.).
symbolId	int64	required	Unique identifier of the Symbol in cTrader platform.

ProtoOASubscribeLiveTrendbarRes

Response to the ProtoOASubscribeLiveTrendbarReq request.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_SUBSCRIBE_LIVE_TRENDBAR_RES
ctidTraderAccountId	int64	required	Unique identifier of the trader's account. Used to match responses to trader's accounts.

ProtoOASubscribeSpotsReq

Request for subscribing on spot events of the specified symbol.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_SUBSCRIBE_SPOTS_REQ
ctidTraderAccountId	int64	required	Unique identifier of the trader's account. Used to match responses to trader's accounts.
symbolId	int64	repeated	Unique identifier of the Symbol in cTrader platform.

ProtoOASubscribeSpotsRes

Response to the ProtoOASubscribeSpotsReq request.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_SUBSCRIBE_SPOTS_RES
ctidTraderAccountId	int64	required	Unique identifier of the trader's account. Used to match responses to trader's accounts.

ProtoOASymbolByIdReq

Request for getting a full symbol entity.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_SYMBOL_BY_ID_REQ
ctidTraderAccountId	int64	required	Unique identifier of the trader's account. Used to match responses to trader's accounts.
symbolId	int64	repeated	Unique identifier of the symbol in cTrader platform.

ProtoOASymbolByIdRes

Response to the ProtoOASymbolByIdReq request.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_SYMBOL_BY_ID_RES
ctidTraderAccountId	int64	required	Unique identifier of the trader's account. Used to match responses to trader's accounts.
symbol	ProtoOASymbol	repeated	Symbol entity with the full set of fields.
archivedSymbol	ProtoOAArchivedSymbol	repeated	Archived symbols.

ProtoOASymbolCategoryListReq

Request for a list of symbol categories available for a trading account.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_SYMBOL_CATEGORY_REQ
ctidTraderAccountId	int64	required	Unique identifier of the trader's account. Used to match responses to trader's accounts.

ProtoOASymbolCategoryListRes

Response to the ProtoSymbolCategoryListReq request.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_SYMBOL_CATEGORY_RES
ctidTraderAccountId	int64	required	Unique identifier of the trader's account. Used to match responses to trader's accounts.
symbolCategory	ProtoOASymbolCategory	repeated	The list of symbol categories.

ProtoOASymbolChangedEvent

Event that is sent when the symbol is changed on the Server side.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_SYMBOL_CHANGED_EVENT
ctidTraderAccountId	int64	required	Unique identifier of the trader's account. Used to match responses to trader's accounts.
symbolId	int64	repeated	Unique identifier of the Symbol in cTrader platform.

ProtoOASymbolsForConversionReq

Request for getting a conversion chain between two assets that consists of several symbols. Use when no direct quote is available

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_SYMBOLS_FOR_CONVERSION_REQ
ctidTraderAccountId	int64	required	Unique identifier of the trader's account. Used to match responses to trader's accounts.
firstAssetId	int64	required	The ID of the firs asset in the conversation chain. e.g.: for EUR/USD the firstAssetId is EUR ID and lastAssetId is USD ID.
lastAssetId	int64	required	The ID of the last asset in the conversation chain. e.g.: for EUR/USD the firstAssetId is EUR ID and lastAssetId is USD ID.

ProtoOASymbolsForConversionRes

Response to the ProtoOASymbolsForConversionReq request.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_SYMBOLS_FOR_CONVERSION_RES
ctidTraderAccountId	int64	required	Unique identifier of the trader's account. Used to match responses to trader's accounts.
symbol	ProtoOALightSymbol	repeated	Conversion chain of the symbols (e.g. EUR/USD, USD/JPY, GBP/JPY -> EUR/GBP).

ProtoOASymbolsListReq

Request for a list of symbols available for a trading account. Symbol entries are returned with the limited set of fields.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_SYMBOLS_LIST_REQ
ctidTraderAccountId	int64	required	Unique identifier of the trader's account. Used to match responses to trader's accounts.
includeArchivedSymbols	bool	optional	Default: false

ProtoOASymbolsListRes

Response to the ProtoOASymbolsListReq request.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_SYMBOLS_LIST_RES
ctidTraderAccountId	int64	required	Unique identifier of the trader's account. Used to match responses to trader's accounts.
symbol	ProtoOALightSymbol	repeated	The list of symbols.
archivedSymbol	ProtoOAArchivedSymbol	repeated	The list of archived symbols.

ProtoOATraderReq

Request for getting data of Trader's Account.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_TRADER_REQ
ctidTraderAccountId	int64	required	Unique identifier of the trader's account. Used to match responses to trader's accounts.

ProtoOATraderRes

Response to the ProtoOATraderReq request.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_TRADER_RES
ctidTraderAccountId	int64	required	Unique identifier of the trader's account. Used to match responses to trader's accounts.
trader	ProtoOATrader	required	The Trader account information.

ProtoOATraderUpdatedEvent

Event that is sent when a Trader is updated on Server side.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_TRADER_UPDATE_EVENT
ctidTraderAccountId	int64	required	Unique identifier of the trader's account. Used to match responses to trader's accounts.
trader	ProtoOATrader	required	The Trader account information.

ProtoOATrailingSLChangedEvent

Event that is sent when the level of the Trailing Stop Loss is changed due to the price level changes.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_TRAILING_SL_CHANGED_EVENT
ctidTraderAccountId	int64	required	Unique identifier of the trader's account. Used to match responses to trader's accounts.
positionId	int64	required	The unique ID of the position.
orderId	int64	required	The unique ID of the order.
stopPrice	double	required	New value of the Stop Loss price.
utcLastUpdateTimestamp	int64	required	The exact UTC time when the Stop Loss was updated.

ProtoOAUnsubscribeDepthQuotesReq

Request for unsubscribing from the depth of market of the specified symbol.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_UNSUBSCRIBE_DEPTH_QUOTES_REQ
ctidTraderAccountId	int64	required	Unique identifier of the trader's account. Used to match responses to trader's accounts.
symbolId	int64	repeated	Unique identifier of the Symbol in cTrader platform.

ProtoOAUnsubscribeDepthQuotesRes

Response to the ProtoOAUnsubscribeDepthQuotesReq request.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_UNSUBSCRIBE_DEPTH_QUOTES_RES
ctidTraderAccountId	int64	required	Unique identifier of the trader's account. Used to match responses to trader's accounts.

ProtoOAUnsubscribeLiveTrendbarReq

Request for unsubscribing from the live trend bars.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_UNSUBSCRIBE_LIVE_TRENDBAR_REQ
ctidTraderAccountId	int64	required	Unique identifier of the trader's account. Used to match responses to trader's accounts.
period	ProtoOATrendbarPeriod	required	Specifies period of trend bar series (e.g. M1, M10, etc.).
symbolId	int64	required	Unique identifier of the Symbol in cTrader platform.

ProtoOAUnsubscribeLiveTrendbarRes

Response to the ProtoOASubscribeLiveTrendbarReq request.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_UNSUBSCRIBE_LIVE_TRENDBAR_RES
ctidTraderAccountId	int64	required	Unique identifier of the trader's account. Used to match responses to trader's accounts.

ProtoOAUnsubscribeSpotsReq

Request for unsubscribing from the spot events of the specified symbol.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_UNSUBSCRIBE_SPOTS_REQ
ctidTraderAccountId	int64	required	Unique identifier of the trader's account. Used to match responses to trader's accounts.
symbolId	int64	repeated	Unique identifier of the Symbol in cTrader platform.

ProtoOAUnsubscribeSpotsRes

Response to the ProtoOASubscribeSpotsRes request.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_UNSUBSCRIBE_SPOTS_RES
ctidTraderAccountId	int64	required	Unique identifier of the trader's account. Used to match responses to trader's accounts.

ProtoOAVersionReq

Request for getting the proxy version. Can be used to check the current version of the Open API scheme.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_VERSION_REQ

ProtoOAVersionRes

Response to the ProtoOAVersionReq request.

Field	Type	Label	Description
payloadType	ProtoOAPayloadType	optional	Default: PROTO_OA_VERSION_RES
version	string	required	The current version of the server application.

Top

OpenApiModelMessages

ProtoOAArchivedSymbol

Field	Type	Label	Description
symbolId	int64	required
name	string	required
utcLastUpdateTimestamp	int64	required
description	string	optional

ProtoOAAsset

Asset entity.

Field	Type	Label	Description
assetId	int64	required	The unique asset ID.
name	string	required	The asset name.
displayName	string	optional	User friendly name.
digits	int32	optional	Precision of the asset.

ProtoOAAssetClass

Asset class entity.

Field	Type	Label	Description
id	int64	optional	Unique asset ID.
name	string	optional	Asset class name.

ProtoOABonusDepositWithdraw

Bonus deposit/withdrawal entity.

Field	Type	Label	Description
operationType	ProtoOAChangeBonusType	required	Type of the operation. Deposit/Withdrawal.
bonusHistoryId	int64	required	The unique ID of the bonus deposit/withdrawal operation.
managerBonus	int64	required	Total amount of broker's bonus after the operation.
managerDelta	int64	required	Amount of bonus deposited/withdrew by manager.
ibBonus	int64	required	Total amount of introducing broker's bonus after the operation.
ibDelta	int64	required	Amount of bonus deposited/withdrew by introducing broker.
changeBonusTimestamp	int64	required	Time when the bonus operation was executed.
externalNote	string	optional	Note added to operation. Visible to the trader.
introducingBrokerId	int64	optional	ID of introducing broker who deposited/withdrew bonus.
moneyDigits	uint32	optional	Specifies the exponent of the monetary values. E.g. moneyDigits = 8 must be interpret as business value multiplied by 10^8, then real balance would be 10053099944 / 10^8 = 100.53099944. Affects managerBonus, managerDelta, ibBonus, ibDelta.

ProtoOAClosePositionDetail

Trading details for closing deal.

Field	Type	Label	Description
entryPrice	double	required	Position price at the moment of filling the closing order.
grossProfit	int64	required	Amount of realized gross profit after closing deal execution.
swap	int64	required	Amount of realized swap related to closed volume.
commission	int64	required	Amount of realized commission related to closed volume.
balance	int64	required	Account balance after closing deal execution.
quoteToDepositConversionRate	double	optional	Quote/Deposit currency conversion rate on the time of closing deal execution.
closedVolume	int64	optional	Closed volume in cents.
balanceVersion	int64	optional	Balance version of the account related to closing deal operation.
moneyDigits	uint32	optional	Specifies the exponent of the monetary values. E.g. moneyDigits = 8 must be interpret as business value multiplied by 10^8, then real balance would be 10053099944 / 10^8 = 100.53099944. Affects grossProfit, swap, commission, balance.

ProtoOACtidProfile

Trader profile entity. Empty due to GDPR.

Field	Type	Label	Description
userId	int64	required

ProtoOACtidTraderAccount

Trader account entity.

Field	Type	Label	Description
ctidTraderAccountId	uint64	required	Unique identifier of the trader's account. Used to match responses to trader's accounts.cTrader platform. Different brokers might have different ids
isLive	bool	optional	If TRUE then the account is belong to Live environment and live host must be used to authorize it
traderLogin	int64	optional	TraderLogin for a specific account. Value is displayed on Client App UI
lastClosingDealTimestamp	int64	optional
lastBalanceUpdateTimestamp	int64	optional

ProtoOADeal

Execution entity.

Field	Type	Label	Description
dealId	int64	required	The unique ID of the execution deal.
orderId	int64	required	Source order of the deal.
positionId	int64	required	Source position of the deal.
volume	int64	required	Volume sent for execution, in cents.
filledVolume	int64	required	Filled volume, in cents.
symbolId	int64	required	The unique identifier of the symbol in specific server environment within cTrader platform. Different servers have different IDs.
createTimestamp	int64	required	Time when the deal was sent for execution.
executionTimestamp	int64	required	Time when the deal was executed.
utcLastUpdateTimestamp	int64	optional	Timestamp when the deal was created, executed or rejected.
executionPrice	double	optional	Execution price.
tradeSide	ProtoOATradeSide	required	Buy/Sell.
dealStatus	ProtoOADealStatus	required	Status of the deal.
marginRate	double	optional	Rate for used margin computation. Represented as Base/Deposit.
commission	int64	optional	Amount of trading commission associated with the deal.
baseToUsdConversionRate	double	optional	Base to USD conversion rate on the time of deal execution.
closePositionDetail	ProtoOAClosePositionDetail	optional	Closing position detail. Valid only for closing deal.
moneyDigits	uint32	optional	Specifies the exponent of the monetary values. E.g. moneyDigits = 8 must be interpret as business value multiplied by 10^8, then real balance would be 10053099944 / 10^8 = 100.53099944. Affects commission.

ProtoOADepositWithdraw

Account deposit/withdrawal operation entity.

Field	Type	Label	Description
operationType	ProtoOAChangeBalanceType	required	Type of the operation. Deposit/Withdrawal.
balanceHistoryId	int64	required	The unique ID of the deposit/withdrawal operation.
balance	int64	required	Account balance after the operation was executed.
delta	int64	required	Amount of deposit/withdrawal operation.
changeBalanceTimestamp	int64	required	Time when deposit/withdrawal operation was executed.
externalNote	string	optional	Note added to operation. Visible to the trader.
balanceVersion	int64	optional	Balance version used to identify the final balance. Increments each time when the trader's account balance is changed.
equity	int64	optional	Total account's equity after balance operation was executed.
moneyDigits	uint32	optional	Specifies the exponent of the monetary values. E.g. moneyDigits = 8 must be interpret as business value multiplied by 10^8, then real balance would be 10053099944 / 10^8 = 100.53099944. Affects balance, delta, equity.

ProtoOADepthQuote

Depth of market entity.

Field	Type	Label	Description
id	uint64	required	Quote ID.
size	uint64	required	Quote size in cents.
bid	uint64	optional	Bid price for bid quotes.
ask	uint64	optional	Ask price for ask quotes.

ProtoOAExpectedMargin

Expected margin computation entity.

Field	Type	Label	Description
volume	int64	required	Volume in cents used for computation of expected margin.
buyMargin	int64	required	Buy margin amount.
sellMargin	int64	required	Sell margin amount.

ProtoOAHoliday

Field	Type	Label	Description
holidayId	int64	required	Unique ID of holiday.
name	string	required	Name of holiday.
description	string	optional	Description of holiday.
scheduleTimeZone	string	required	Timezone used for holiday.
holidayDate	int64	required	Amount of days from 01-01-1970, multiply it by 86400000 to get unix timestamp.
isRecurring	bool	required	If TRUE, then the holiday happens each year.
startSecond	int32	optional	Amount of seconds from 00:00:00 of the holiday day when holiday actually starts.
endSecond	int32	optional	Amount of seconds from 00:00:00 of the holiday day when holiday actually finishes.

ProtoOAInterval

Symbol trading session entity.

Field	Type	Label	Description
startSecond	uint32	required	Interval start, specified in seconds starting from SUNDAY 00:00 in specified time zone (inclusive to the interval).
endSecond	uint32	required	Interval end, specified in seconds starting from SUNDAY 00:00 in specified time zone (exclusive from the interval).

ProtoOALightSymbol

Lightweight symbol entity.

Field	Type	Label	Description
symbolId	int64	required	The unique identifier of the symbol in specific server environment within cTrader platform. Different brokers might have different IDs.
symbolName	string	optional	Name of the symbol (e.g. EUR/USD).
enabled	bool	optional	If TRUE then symbol is visible for traders.
baseAssetId	int64	optional	Base asset.
quoteAssetId	int64	optional	Quote asset.
symbolCategoryId	int64	optional	Id of the symbol category used for symbols grouping.
description	string	optional

ProtoOAMarginCall

Margin call entity, specifies threshold for exact margin call type. Only 3 instances of margin calls are supported, identified by marginCallType. See ProtoOANotificationType for details.

Field	Type	Label	Description
marginCallType	ProtoOANotificationType	required
marginLevelThreshold	double	required
utcLastUpdateTimestamp	int64	optional

ProtoOAOrder

Trade order entity.

Field	Type	Label	Description
orderId	int64	required	The unique ID of the order. Note: trader might have two orders with the same id if orders are taken from accounts from different brokers.
tradeData	ProtoOATradeData	required	Detailed trader data.
orderType	ProtoOAOrderType	required	Order type.
orderStatus	ProtoOAOrderStatus	required	Order status.
expirationTimestamp	int64	optional	If the order has time in force GTD then expiration is specified.
executionPrice	double	optional	Price at which an order was executed. For order with FILLED status.
executedVolume	int64	optional	Part of the volume that was filled.
utcLastUpdateTimestamp	int64	optional	Timestamp of the last update of the order.
baseSlippagePrice	double	optional	Used for Market Range order with combination of slippageInPoints to specify price range were order can be executed.
slippageInPoints	int64	optional	Used for Market Range and STOP_LIMIT orders to to specify price range were order can be executed.
closingOrder	bool	optional	If TRUE then the order is closing part of whole position. Must have specified positionId.
limitPrice	double	optional	Valid only for LIMIT orders.
stopPrice	double	optional	Valid only for STOP and STOP_LIMIT orders.
stopLoss	double	optional	Absolute stopLoss price.
takeProfit	double	optional	Absolute takeProfit price.
clientOrderId	string	optional	Optional ClientOrderId. Max Length = 50 chars.
timeInForce	ProtoOATimeInForce	optional	Order's time in force. Depends on order type. Default: IMMEDIATE_OR_CANCEL
positionId	int64	optional	ID of the position linked to the order (e.g. closing order, order that increase volume of a specific position, etc.).
relativeStopLoss	int64	optional	Relative stopLoss that can be specified instead of absolute as one. Specified in 1/100_000 of unit of a price. For BUY stopLoss = entryPrice - relativeStopLoss, for SELL stopLoss = entryPrice + relativeStopLoss.
relativeTakeProfit	int64	optional	Relative takeProfit that can be specified instead of absolute one. Specified in 1/100_000 of unit of a price. ForBUY takeProfit = entryPrice + relativeTakeProfit, for SELL takeProfit = entryPrice - relativeTakeProfit.
isStopOut	bool	optional	If TRUE then order was stopped out from server side.
trailingStopLoss	bool	optional	If TRUE then order is trailingStopLoss. Valid for STOP_LOSS_TAKE_PROFIT order.
stopTriggerMethod	ProtoOAOrderTriggerMethod	optional	Trigger method for the order. Valid only for STOP and STOP_LIMIT orders. Default: TRADE

ProtoOAPosition

Trade position entity.

Field	Type	Label	Description
positionId	int64	required	The unique ID of the position. Note: trader might have two positions with the same id if positions are taken from accounts from different brokers.
tradeData	ProtoOATradeData	required	Position details. See ProtoOATradeData for details.
positionStatus	ProtoOAPositionStatus	required	Current status of the position.
swap	int64	required	Total amount of charged swap on open position.
price	double	optional	VWAP price of the position based on all executions (orders) linked to the position.
stopLoss	double	optional	Current stop loss price.
takeProfit	double	optional	Current take profit price.
utcLastUpdateTimestamp	int64	optional	Time of the last change of the position, including amend SL/TP of the position, execution of related order, cancel or related order, etc.
commission	int64	optional	Current unrealized commission related to the position.
marginRate	double	optional	Rate for used margin computation. Represented as Base/Deposit.
mirroringCommission	int64	optional	Amount of unrealized commission related to following of strategy provider.
guaranteedStopLoss	bool	optional	If TRUE then position's stop loss is guaranteedStopLoss.
usedMargin	uint64	optional	Amount of margin used for the position in deposit currency.
stopLossTriggerMethod	ProtoOAOrderTriggerMethod	optional	Stop trigger method for SL/TP of the position. Default: TRADE
moneyDigits	uint32	optional	Specifies the exponent of the monetary values. E.g. moneyDigits = 8 must be interpret as business value multiplied by 10^8, then real balance would be 10053099944 / 10^8 = 100.53099944. Affects swap, commission, mirroringCommission, usedMargin.

ProtoOASymbol

Trading symbol entity.

Field	Type	Label	Description
symbolId	int64	required	The unique identifier of the symbol in specific server environment within cTrader platform. Different servers have different IDs.
digits	int32	required	Number of price digits to be displayed.
pipPosition	int32	required	Pip position on digits.
enableShortSelling	bool	optional	If TRUE then the short selling with the symbol is enabled.
guaranteedStopLoss	bool	optional	If TRUE then setting of guaranteedStopLoss is available for limited risk accounts.
swapRollover3Days	ProtoOADayOfWeek	optional	Day of the week when SWAP charge amount will be tripled. Doesn't impact Rollover Commission. Default: MONDAY
swapLong	double	optional	SWAP charge for long positions.
swapShort	double	optional	SWAP charge for short positions.
maxVolume	int64	optional	Maximum allowed volume in cents for an order with a symbol.
minVolume	int64	optional	Minimum allowed volume in cents for an order with a symbol.
stepVolume	int64	optional	Step of the volume in cents for an order.
maxExposure	uint64	optional	Value of max exposure per symbol, per account. Blocks execution if breached.
schedule	ProtoOAInterval	repeated	Symbol trading interval, specified in seconds starting from SUNDAY 00:00 in specified time zone.
commission	int64	optional	Deprecated. Commission base amount. Total commission depends on commissionType. Use preciseTradingCommissionRate.
commissionType	ProtoOACommissionType	optional	Commission type. See ProtoOACommissionType for details. Default: USD_PER_MILLION_USD
slDistance	uint32	optional	Minimum allowed distance between stop loss and current market price.
tpDistance	uint32	optional	Minimum allowed distance between take profit and current market price.
gslDistance	uint32	optional	Minimum allowed distance between guaranteed stop loss and current market price.
gslCharge	int64	optional	Guaranteed stop loss fee.
distanceSetIn	ProtoOASymbolDistanceType	optional	Unit of distance measure for slDistance, tpDistance, gslDistance. Default: SYMBOL_DISTANCE_IN_POINTS
minCommission	int64	optional	Deprecated. Minimum commission amount per trade. Use preciseMinCommission.
minCommissionType	ProtoOAMinCommissionType	optional	Minimum commission Type. See ProtoOAMinCommissionType for details. Default: CURRENCY
minCommissionAsset	string	optional	Currency for minimum commission. (USD or quote currency). Default: USD
rolloverCommission	int64	optional	Amount of commission per trade for Shariah Compliant accounts in deposit currency (swapFree = TRUE).
skipRolloverDays	int32	optional	Initial period before the first rolloverCommission will be charged on the account.
scheduleTimeZone	string	optional	Time zone for the symbol trading intervals.
tradingMode	ProtoOATradingMode	optional	Rules for trading with the symbol. See ProtoOATradingMode for details. Default: ENABLED
rolloverCommission3Days	ProtoOADayOfWeek	optional	Day of the week (in UTC) when Administrative Fee charge amount will be tripled. Applied only if RolloverChargePeriod = 0 or 1 Default: MONDAY
swapCalculationType	ProtoOASwapCalculationType	optional	Specifies type of SWAP computation as PIPS (0) or PERCENTAGE (1, annual, in percent) Default: PIPS
lotSize	int64	optional	Lot size of the Symbol (in cents)
preciseTradingCommissionRate	int64	optional	Commission base amount. Total commission depends on commissionType: for non-percentage types it is multiplied by 10^8.
preciseMinCommission	int64	optional	Minimum commission amount per trade multiplied by 10^8.
holiday	ProtoOAHoliday	repeated	List of holidays for this symbol specified by broker.

ProtoOASymbolCategory

Symbol category entity.

Field	Type	Label	Description
id	int64	required	The unique identifier of the symbol category.
assetClassId	int64	required	Link to the asset class. One asset class can have many symbol categories.
name	string	required	Category name.

ProtoOATickData

Historical tick data type.

Field	Type	Label	Description
timestamp	int64	required	Tick timestamp.
tick	int64	required	Tick price.

ProtoOATradeData

Position/order trading details entity.

Field	Type	Label	Description
symbolId	int64	required	The unique identifier of the symbol in specific server environment within cTrader platform. Different brokers might have different IDs.
volume	int64	required	Volume in cents.
tradeSide	ProtoOATradeSide	required	Buy, Sell.
openTimestamp	int64	optional	Time when position was opened or order was created.
label	string	optional	Text label specified during order request.
guaranteedStopLoss	bool	optional	If TRUE then position/order stop loss is guaranteedStopLoss.
comment	string	optional	User-specified comment.

ProtoOATrader

Trading account entity.

Field	Type	Label	Description
ctidTraderAccountId	int64	required	The unique Trader's Account ID used to match the responses to the Trader's Account.
balance	int64	required	Current account balance.
balanceVersion	int64	optional	Balance version used to identify the final balance. Increments each time when the trader's account balance is changed.
managerBonus	int64	optional	Amount of broker's bonus allocated to the account.
ibBonus	int64	optional	Amount of introducing broker bonus allocated to the account.
nonWithdrawableBonus	int64	optional	Broker's bonus that cannot be withdrew from the account as cash.
accessRights	ProtoOAAccessRights	optional	Access rights that an owner has to the account in cTrader platform. See ProtoOAAccessRights for details. Default: FULL_ACCESS
depositAssetId	int64	required	Deposit currency of the account.
swapFree	bool	optional	If TRUE then account is Shariah compliant.
leverageInCents	uint32	optional	Account leverage (e.g. If leverage = 1:50 then value = 5000).
totalMarginCalculationType	ProtoOATotalMarginCalculationType	optional	Margin computation type for the account (MAX, SUM, NET).
maxLeverage	uint32	optional	Maximum allowed leverage for the account. Used as validation when a Trader can change leverage value.
frenchRisk	bool	optional	Deprecated. If TRUE then account is AMF compliant. Use isLimitedRisk and limitedRiskMarginCalculationStrategy.
traderLogin	int64	optional	ID of the account that is unique per server (Broker).
accountType	ProtoOAAccountType	optional	Account type: HEDGED, NETTED, etc. Default: HEDGED
brokerName	string	optional	Some whitelabel assigned to trader by broker at the moment of account creation.
registrationTimestamp	int64	optional	Unix timestamp of the account registration. Should be used as minimal date in historical data requests.
isLimitedRisk	bool	optional	If TRUE then account is compliant to use specific margin calculation strategy.
limitedRiskMarginCalculationStrategy	ProtoOALimitedRiskMarginCalculationStrategy	optional	Special strategy used in margin calculations for this account (if account isLimitedRisk). Default: ACCORDING_TO_LEVERAGE
moneyDigits	uint32	optional	Specifies the exponent of the monetary values. E.g. moneyDigits = 8 must be interpret as business value multiplied by 10^8, then real balance would be 10053099944 / 10^8 = 100.53099944. Affects balance, managerBonus, ibBonus, nonWithdrawableBonus.

ProtoOATrendbar

Historical Trendbar entity.

Field	Type	Label	Description
volume	int64	required	Bar volume in ticks.
period	ProtoOATrendbarPeriod	optional	Bar period. Default: M1
low	int64	optional	Low price of the bar.
deltaOpen	uint64	optional	Delta between open and low price. open = low + deltaOpen.
deltaClose	uint64	optional	Delta between close and low price. close = low + deltaClose.
deltaHigh	uint64	optional	Delta between high and low price. high = low + deltaHigh.
utcTimestampInMinutes	uint32	optional	Timestamp of the bar. Equal to the timestamp of the open tick.

ProtoOAAccessRights

Enum for specifying access right for a trader.

Name	Number	Description
FULL_ACCESS	0	Enable all trading.
CLOSE_ONLY	1	Only closing trading request are enabled.
NO_TRADING	2	View only access.
NO_LOGIN	3	No access.

ProtoOAAccountType

Enum for specifying type of an account.

Name	Number	Description
HEDGED	0	Allows multiple positions on a trading account for a symbol.
NETTED	1	Only one position per symbol is allowed on a trading account.
SPREAD_BETTING	2	Spread betting type account.

ProtoOAChangeBalanceType

Balance operation entity. Covers all cash movement operations related to account, trading, IB operations, mirroring, etc.

Name	Number	Description
BALANCE_DEPOSIT	0	Cash deposit.
BALANCE_WITHDRAW	1	Cash withdrawal.
BALANCE_DEPOSIT_STRATEGY_COMMISSION_INNER	3	Received mirroring commission.
BALANCE_WITHDRAW_STRATEGY_COMMISSION_INNER	4	Paid mirroring commission.
BALANCE_DEPOSIT_IB_COMMISSIONS	5	For IB account. Commissions paid by trader.
BALANCE_WITHDRAW_IB_SHARED_PERCENTAGE	6	For IB account. Withdrawal of commissions shared with broker.
BALANCE_DEPOSIT_IB_SHARED_PERCENTAGE_FROM_SUB_IB	7	For IB account. Commissions paid by sub-ibs.
BALANCE_DEPOSIT_IB_SHARED_PERCENTAGE_FROM_BROKER	8	For IB account. Commissions paid by broker.
BALANCE_DEPOSIT_REBATE	9	Deposit rebate for trading volume for period.
BALANCE_WITHDRAW_REBATE	10	Withdrawal of rebate.
BALANCE_DEPOSIT_STRATEGY_COMMISSION_OUTER	11	Mirroring commission.
BALANCE_WITHDRAW_STRATEGY_COMMISSION_OUTER	12	Mirroring commission.
BALANCE_WITHDRAW_BONUS_COMPENSATION	13	For IB account. Share commission with the Broker.
BALANCE_WITHDRAW_IB_SHARED_PERCENTAGE_TO_BROKER	14	IB commissions.
BALANCE_DEPOSIT_DIVIDENDS	15	Deposit dividends payments.
BALANCE_WITHDRAW_DIVIDENDS	16	Negative dividend charge for short position.
BALANCE_WITHDRAW_GSL_CHARGE	17	Charge for guaranteedStopLoss.
BALANCE_WITHDRAW_ROLLOVER	18	Charge of rollover fee for Shariah compliant accounts.
BALANCE_DEPOSIT_NONWITHDRAWABLE_BONUS	19	Broker's operation to deposit bonus.
BALANCE_WITHDRAW_NONWITHDRAWABLE_BONUS	20	Broker's operation to withdrawal bonus.
BALANCE_DEPOSIT_SWAP	21	Deposits of negative SWAP.
BALANCE_WITHDRAW_SWAP	22	SWAP charges.
BALANCE_DEPOSIT_MANAGEMENT_FEE	27	Mirroring commission.
BALANCE_WITHDRAW_MANAGEMENT_FEE	28	Mirroring commission. Deprecated since 7.1 in favor of BALANCE_WITHDRAW_COPY_FEE (34).
BALANCE_DEPOSIT_PERFORMANCE_FEE	29	Mirroring commission.
BALANCE_WITHDRAW_FOR_SUBACCOUNT	30
BALANCE_DEPOSIT_TO_SUBACCOUNT	31
BALANCE_WITHDRAW_FROM_SUBACCOUNT	32
BALANCE_DEPOSIT_FROM_SUBACCOUNT	33
BALANCE_WITHDRAW_COPY_FEE	34	Withdrawal fees to Strategy Provider.
BALANCE_WITHDRAW_INACTIVITY_FEE	35	Withdraw of inactivity fee from the balance
BALANCE_DEPOSIT_TRANSFER	36
BALANCE_WITHDRAW_TRANSFER	37
BALANCE_DEPOSIT_CONVERTED_BONUS	38

ProtoOAChangeBonusType

Bonus operation type ENUM.

Name	Number	Description
BONUS_DEPOSIT	0
BONUS_WITHDRAW	1

ProtoOAClientPermissionScope

Open API application permission in regards to token ENUM.

Name	Number	Description
SCOPE_VIEW	0	Allows to use only view commends. Trade is prohibited.
SCOPE_TRADE	1	Allows to use all commands.

ProtoOACommissionType

Enum for specifying type of trading commission.

Name	Number	Description
USD_PER_MILLION_USD	1	USD per million USD volume - usually used for FX. Example: 50 USD for 1 mil USD of trading volume.
USD_PER_LOT	2	USD per 1 lot - usually used for CFDs and futures for commodities, and indices. Example: 15 USD for 1 contract.
PERCENTAGE_OF_VALUE	3	Percentage of trading volume - usually used for Equities. Example: 0.005% of notional trading volume. Multiplied by 100,00.
QUOTE_CCY_PER_LOT	4	Quote ccy of Symbol per 1 lot - will be used for CFDs and futures for commodities, and indices. Example: 15 EUR for 1 contract of DAX.

ProtoOADayOfWeek

Name	Number	Description
NONE	0
MONDAY	1
TUESDAY	2
WEDNESDAY	3
THURSDAY	4
FRIDAY	5
SATURDAY	6
SUNDAY	7

ProtoOADealStatus

Deal status ENUM.

Name	Number	Description
FILLED	2	Deal filled.
PARTIALLY_FILLED	3	Deal is partially filled.
REJECTED	4	Deal is correct but was rejected by liquidity provider (e.g. no liquidity).
INTERNALLY_REJECTED	5	Deal rejected by server (e.g. no price quotes).
ERROR	6	Deal is rejected by LP due to error (e.g. symbol is unknown).
MISSED	7	Liquidity provider did not sent response on the deal during specified execution time period.

ProtoOAErrorCode

Error code ENUM.

Name	Number	Description
OA_AUTH_TOKEN_EXPIRED	1	When token used for account authorization is expired.
ACCOUNT_NOT_AUTHORIZED	2	When account is not authorized.
ALREADY_LOGGED_IN	14	When client tries to authorize after it was already authorized
CH_CLIENT_AUTH_FAILURE	101	Open API client is not activated or wrong client credentials.
CH_CLIENT_NOT_AUTHENTICATED	102	When a command is sent for not authorized Open API client.
CH_CLIENT_ALREADY_AUTHENTICATED	103	Client is trying to authenticate twice.
CH_ACCESS_TOKEN_INVALID	104	Access token is invalid.
CH_SERVER_NOT_REACHABLE	105	Trading service is not available.
CH_CTID_TRADER_ACCOUNT_NOT_FOUND	106	Trading account is not found.
CH_OA_CLIENT_NOT_FOUND	107	Could not find this client id.
REQUEST_FREQUENCY_EXCEEDED	108	Request frequency is reached.
SERVER_IS_UNDER_MAINTENANCE	109	Server is under maintenance.
CHANNEL_IS_BLOCKED	110	Operations are not allowed for this account.
CONNECTIONS_LIMIT_EXCEEDED	67	Limit of connections is reached for this Open API client.
WORSE_GSL_NOT_ALLOWED	68	Not allowed to increase risk for Positions with Guaranteed Stop Loss.
SYMBOL_HAS_HOLIDAY	69	Trading disabled because symbol has holiday.
NOT_SUBSCRIBED_TO_SPOTS	112	When trying to subscribe to depth, trendbars, etc. without spot subscription.
ALREADY_SUBSCRIBED	113	When subscription is requested for an active.
SYMBOL_NOT_FOUND	114	Symbol not found.
UNKNOWN_SYMBOL	115	Note: to be merged with SYMBOL_NOT_FOUND.
INCORRECT_BOUNDARIES	35	When requested period (from,to) is too large or invalid values are set to from/to.
NO_QUOTES	117	Trading cannot be done as not quotes are available. Applicable for Book B.
NOT_ENOUGH_MONEY	118	Not enough funds to allocate margin.
MAX_EXPOSURE_REACHED	119	Max exposure limit is reached for a {trader, symbol, side}.
POSITION_NOT_FOUND	120	Position not found.
ORDER_NOT_FOUND	121	Order not found.
POSITION_NOT_OPEN	122	When trying to close a position that it is not open.
POSITION_LOCKED	123	Position in the state that does not allow to perform an operation.
TOO_MANY_POSITIONS	124	Trading account reached its limit for max number of open positions and orders.
TRADING_BAD_VOLUME	125	Invalid volume.
TRADING_BAD_STOPS	126	Invalid stop price.
TRADING_BAD_PRICES	127	Invalid price (e.g. negative).
TRADING_BAD_STAKE	128	Invalid stake volume (e.g. negative).
PROTECTION_IS_TOO_CLOSE_TO_MARKET	129	Invalid protection prices.
TRADING_BAD_EXPIRATION_DATE	130	Invalid expiration.
PENDING_EXECUTION	131	Unable to apply changes as position has an order under execution.
TRADING_DISABLED	132	Trading is blocked for the symbol.
TRADING_NOT_ALLOWED	133	Trading account is in read only mode.
UNABLE_TO_CANCEL_ORDER	134	Unable to cancel order.
UNABLE_TO_AMEND_ORDER	135	Unable to amend order.
SHORT_SELLING_NOT_ALLOWED	136	Short selling is not allowed.

ProtoOAExecutionType

Execution event type ENUM.

Name	Number	Description
ORDER_ACCEPTED	2	Order passed validation.
ORDER_FILLED	3	Order filled.
ORDER_REPLACED	4	Pending order is changed with a new one.
ORDER_CANCELLED	5	Order cancelled.
ORDER_EXPIRED	6	Order with GTD time in force is expired.
ORDER_REJECTED	7	Order is rejected due to validations.
ORDER_CANCEL_REJECTED	8	Cancel order request is rejected.
SWAP	9	Type related to SWAP execution events.
DEPOSIT_WITHDRAW	10	Type related to event of deposit or withdrawal cash flow operation.
ORDER_PARTIAL_FILL	11	Order is partially filled.
BONUS_DEPOSIT_WITHDRAW	12	Type related to event of bonus deposit or bonus withdrawal.

ProtoOALimitedRiskMarginCalculationStrategy

Name	Number	Description
ACCORDING_TO_LEVERAGE	0
ACCORDING_TO_GSL	1
ACCORDING_TO_GSL_AND_LEVERAGE	2

ProtoOAMinCommissionType

Enum for specifying type of minimum trading commission.

Name	Number	Description
CURRENCY	1
QUOTE_CURRENCY	2

ProtoOANotificationType

Type of notification, currently only 3 instances of marginCall are supported.

Name	Number	Description
MARGIN_LEVEL_THRESHOLD_1	61	one of three margin calls, they are all similar.
MARGIN_LEVEL_THRESHOLD_2	62	one of three margin calls, they are all similar.
MARGIN_LEVEL_THRESHOLD_3	63	one of three margin calls, they are all similar.

ProtoOAOrderStatus

Order status ENUM.

Name	Number	Description
ORDER_STATUS_ACCEPTED	1	Order request validated and accepted for execution.
ORDER_STATUS_FILLED	2	Order is fully filled.
ORDER_STATUS_REJECTED	3	Order is rejected due to validation.
ORDER_STATUS_EXPIRED	4	Order expired. Might be valid for orders with partially filled volume that were expired on LP.
ORDER_STATUS_CANCELLED	5	Order is cancelled. Might be valid for orders with partially filled volume that were cancelled by LP.

ProtoOAOrderTriggerMethod

Stop Order and Stop Lost triggering method ENUM.

Name	Number	Description
TRADE	1	Stop Order: buy is triggered by ask, sell by bid; Stop Loss Order: for buy position is triggered by bid and for sell position by ask.
OPPOSITE	2	Stop Order: buy is triggered by bid, sell by ask; Stop Loss Order: for buy position is triggered by ask and for sell position by bid.
DOUBLE_TRADE	3	The same as TRADE, but trigger is checked after the second consecutive tick.
DOUBLE_OPPOSITE	4	The same as OPPOSITE, but trigger is checked after the second consecutive tick.

ProtoOAOrderType

Order type ENUM.

Name	Number	Description
MARKET	1
LIMIT	2
STOP	3
STOP_LOSS_TAKE_PROFIT	4
MARKET_RANGE	5
STOP_LIMIT	6

ProtoOAPayloadType

Name	Number	Description
PROTO_OA_APPLICATION_AUTH_REQ	2100
PROTO_OA_APPLICATION_AUTH_RES	2101
PROTO_OA_ACCOUNT_AUTH_REQ	2102
PROTO_OA_ACCOUNT_AUTH_RES	2103
PROTO_OA_VERSION_REQ	2104
PROTO_OA_VERSION_RES	2105
PROTO_OA_NEW_ORDER_REQ	2106
PROTO_OA_TRAILING_SL_CHANGED_EVENT	2107
PROTO_OA_CANCEL_ORDER_REQ	2108
PROTO_OA_AMEND_ORDER_REQ	2109
PROTO_OA_AMEND_POSITION_SLTP_REQ	2110
PROTO_OA_CLOSE_POSITION_REQ	2111
PROTO_OA_ASSET_LIST_REQ	2112
PROTO_OA_ASSET_LIST_RES	2113
PROTO_OA_SYMBOLS_LIST_REQ	2114
PROTO_OA_SYMBOLS_LIST_RES	2115
PROTO_OA_SYMBOL_BY_ID_REQ	2116
PROTO_OA_SYMBOL_BY_ID_RES	2117
PROTO_OA_SYMBOLS_FOR_CONVERSION_REQ	2118
PROTO_OA_SYMBOLS_FOR_CONVERSION_RES	2119
PROTO_OA_SYMBOL_CHANGED_EVENT	2120
PROTO_OA_TRADER_REQ	2121
PROTO_OA_TRADER_RES	2122
PROTO_OA_TRADER_UPDATE_EVENT	2123
PROTO_OA_RECONCILE_REQ	2124
PROTO_OA_RECONCILE_RES	2125
PROTO_OA_EXECUTION_EVENT	2126
PROTO_OA_SUBSCRIBE_SPOTS_REQ	2127
PROTO_OA_SUBSCRIBE_SPOTS_RES	2128
PROTO_OA_UNSUBSCRIBE_SPOTS_REQ	2129
PROTO_OA_UNSUBSCRIBE_SPOTS_RES	2130
PROTO_OA_SPOT_EVENT	2131
PROTO_OA_ORDER_ERROR_EVENT	2132
PROTO_OA_DEAL_LIST_REQ	2133
PROTO_OA_DEAL_LIST_RES	2134
PROTO_OA_SUBSCRIBE_LIVE_TRENDBAR_REQ	2135
PROTO_OA_UNSUBSCRIBE_LIVE_TRENDBAR_REQ	2136
PROTO_OA_GET_TRENDBARS_REQ	2137
PROTO_OA_GET_TRENDBARS_RES	2138
PROTO_OA_EXPECTED_MARGIN_REQ	2139
PROTO_OA_EXPECTED_MARGIN_RES	2140
PROTO_OA_MARGIN_CHANGED_EVENT	2141
PROTO_OA_ERROR_RES	2142
PROTO_OA_CASH_FLOW_HISTORY_LIST_REQ	2143
PROTO_OA_CASH_FLOW_HISTORY_LIST_RES	2144
PROTO_OA_GET_TICKDATA_REQ	2145
PROTO_OA_GET_TICKDATA_RES	2146
PROTO_OA_ACCOUNTS_TOKEN_INVALIDATED_EVENT	2147
PROTO_OA_CLIENT_DISCONNECT_EVENT	2148
PROTO_OA_GET_ACCOUNTS_BY_ACCESS_TOKEN_REQ	2149
PROTO_OA_GET_ACCOUNTS_BY_ACCESS_TOKEN_RES	2150
PROTO_OA_GET_CTID_PROFILE_BY_TOKEN_REQ	2151
PROTO_OA_GET_CTID_PROFILE_BY_TOKEN_RES	2152
PROTO_OA_ASSET_CLASS_LIST_REQ	2153
PROTO_OA_ASSET_CLASS_LIST_RES	2154
PROTO_OA_DEPTH_EVENT	2155
PROTO_OA_SUBSCRIBE_DEPTH_QUOTES_REQ	2156
PROTO_OA_SUBSCRIBE_DEPTH_QUOTES_RES	2157
PROTO_OA_UNSUBSCRIBE_DEPTH_QUOTES_REQ	2158
PROTO_OA_UNSUBSCRIBE_DEPTH_QUOTES_RES	2159
PROTO_OA_SYMBOL_CATEGORY_REQ	2160
PROTO_OA_SYMBOL_CATEGORY_RES	2161
PROTO_OA_ACCOUNT_LOGOUT_REQ	2162
PROTO_OA_ACCOUNT_LOGOUT_RES	2163
PROTO_OA_ACCOUNT_DISCONNECT_EVENT	2164
PROTO_OA_SUBSCRIBE_LIVE_TRENDBAR_RES	2165
PROTO_OA_UNSUBSCRIBE_LIVE_TRENDBAR_RES	2166
PROTO_OA_MARGIN_CALL_LIST_REQ	2167
PROTO_OA_MARGIN_CALL_LIST_RES	2168
PROTO_OA_MARGIN_CALL_UPDATE_REQ	2169
PROTO_OA_MARGIN_CALL_UPDATE_RES	2170
PROTO_OA_MARGIN_CALL_UPDATE_EVENT	2171
PROTO_OA_MARGIN_CALL_TRIGGER_EVENT	2172
PROTO_OA_REFRESH_TOKEN_REQ	2173
PROTO_OA_REFRESH_TOKEN_RES	2174

ProtoOAPositionStatus

Position status ENUM.

Name	Number	Description
POSITION_STATUS_OPEN	1
POSITION_STATUS_CLOSED	2
POSITION_STATUS_CREATED	3	Empty position is created for pending order.
POSITION_STATUS_ERROR	4

ProtoOAQuoteType

Price quote type.

Name	Number	Description
BID	1
ASK	2

ProtoOASwapCalculationType

Enum for specifying SWAP calculation type for symbol.

Name	Number	Description
PIPS	0	Specifies type of SWAP computation as PIPS (0)
PERCENTAGE	1	Specifies type of SWAP computation as PERCENTAGE (1, annual, in percent)

ProtoOASymbolDistanceType

Enum for specifying stop loss and take profit distances.

Name	Number	Description
SYMBOL_DISTANCE_IN_POINTS	1
SYMBOL_DISTANCE_IN_PERCENTAGE	2

ProtoOATimeInForce

Order's time in force ENUM.

Name	Number	Description
GOOD_TILL_DATE	1
GOOD_TILL_CANCEL	2
IMMEDIATE_OR_CANCEL	3
FILL_OR_KILL	4
MARKET_ON_OPEN	5

ProtoOATotalMarginCalculationType

Enum for specifying margin calculation type for an account.

Name	Number	Description
MAX	0
SUM	1
NET	2

ProtoOATradeSide

Trader side ENUM. Used for order, position, deal.

Name	Number	Description
BUY	1
SELL	2

ProtoOATradingMode

Enum for specifying symbol trading mode.

Name	Number	Description
ENABLED	0
DISABLED_WITHOUT_PENDINGS_EXECUTION	1
DISABLED_WITH_PENDINGS_EXECUTION	2
CLOSE_ONLY_MODE	3

ProtoOATrendbarPeriod

Trendbar period ENUM.

Name	Number	Description
M1	1
M2	2
M3	3
M4	4
M5	5
M10	6
M15	7
M30	8
H1	9
H4	10
H12	11
D1	12
W1	13
MN1	14

Scalar Value Types

.proto Type	Notes	C++	Java	Python	Go	C#	PHP	Ruby
double		double	double	float	float64	double	float	Float
float		float	float	float	float32	float	float	Float
int32	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int64	long	int/long	int64	long	integer/string	Bignum
uint32	Uses variable-length encoding.	uint32	int	int/long	uint32	uint	integer	Bignum or Fixnum (as required)
uint64	Uses variable-length encoding.	uint64	long	int/long	uint64	ulong	integer/string	Bignum or Fixnum (as required)
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int64	long	int/long	int64	long	integer/string	Bignum
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	uint32	int	int	uint32	uint	integer	Bignum or Fixnum (as required)
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	uint64	long	int/long	uint64	ulong	integer/string	Bignum
sfixed32	Always four bytes.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sfixed64	Always eight bytes.	int64	long	int/long	int64	long	integer/string	Bignum
bool		bool	boolean	boolean	bool	bool	boolean	TrueClass/FalseClass
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String	str/unicode	string	string	string	String (UTF-8)
bytes	May contain any arbitrary sequence of bytes.	string	ByteString	str	[]byte	ByteString	string	String (ASCII-8BIT)