ProtoOAApplicationAuthReq
Request for authorizing an Application to work with the cTrader platform Proxies.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | string | clientId | The unique Client ID provided during the registration. |
| required | string | clientSecret | The unique Client Secret provided during the registration. |
ProtoOAApplicationAuthRes
Response to the ProtoOAApplicationAuthReq request.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType |
ProtoOAAccountAuthReq
Request for authorizing a trading account session. Requires established authorized connection with the client application.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | int64 | ctidTraderAccountId | The unique identifier of the Trader's Account in cTrader platform. |
| required | string | accessToken | The Access Token issued for providing access to the Trader's Account. |
ProtoOAAccountAuthRes
Response to the ProtoOAAccountAuthReq request.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | int64 | ctidTraderAccountId | The unique identifier of the Trader's Account in cTrader platform. |
ProtoOAErrorRes
Generic response when an error occurs.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| optional | int64 | ctidTraderAccountId | The unique identifier of the Trader's Account in cTrader platform. Used to match responses to the Trader's Accounts. |
| required | string | errorCode | The name of the ProtoErrorCode or the other custom ErrorCodes (e.g. ProtoCHErrorCode). |
| optional | string | description | The error description. |
ProtoOAClientDisconnectEvent
The 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.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| optional | string | reason | The disconnection reason explained. For example: The application access was blocked by cTrader Administrator. |
ProtoOAAccountsTokenInvalidatedEvent
Event that occurs when the connection with a specific Trader Account is cancelled by the Server. The existing connections with the other Trader Accounts will be maintained.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| repeated | int64 | ctidTraderAccountIds | Unique identifier of the Trader's Account. Used to match Responses to Trader's Accounts. |
| optional | string | reason | The disconnection reason explained. For example: Access Token is expired or recalled. |
ProtoOAVersionReq
The proxy version request. Can be used to check if the .proto file is not obsolete.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType |
ProtoOAVersionRes
Response to the ProtoOAVersionReq request.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | string | version | The current version of the server application. |
ProtoOANewOrderReq
The request for sending a new trading order. Allowed only if the accessToken field has the "trade" permissions for the Trading Account.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | int64 | ctidTraderAccountId | A unique identifier of the Trader Account. Used to match responses to the Trader’s Accounts |
| required | int64 | symbolId | The unique identifier of the Symbol in cTrader platform. |
| required | ProtoOAOrderType | orderType | The type of order - MARKET, LIMIT, STOP, MARKET_RANGE, STOP_LIMIT. |
| required | ProtoOATradeSide | tradeSide | Trading direction - BUY or SELL. |
| required | int64 | volume | The volume represented in 0.01 of a unit (e.g. US\$ 10.00 = 1000). |
| optional | double | limitPrice | The limit price, can be specified for the LIMIT order only. |
| optional | double | stopPrice | Stop Price, can be specified for the STOP and the STOP_LIMIT orders only. |
| optional | ProtoOATimeInForce | timeInForce | The specific order execution or expiration instruction - GOOD_TILL_DATE, GOOD_TILL_CANCEL, IMMEDIATE_OR_CANCEL, FILL_OR_KILL, MARKET_ON_OPEN. |
| optional | int64 | expirationTimestamp | The exact order expiration time. Should be set for the Good Till Date orders. |
| optional | double | stopLoss | The absolute Stop Loss price (1.23456 for example). Not supported for the MARKER orders. |
| optional | double | takeProfit | The absolute Take Profit price (1.23456 for example). Unsupported for the MARKER orders. |
| optional | string | comment | User-specified comment. MaxLength = 512. |
| optional | double | baseSlippagePrice | Base price to calculate relative slippage price for MARKET_RANGE order. |
| optional | int32 | slippageInPoints | Slippage distance for MARKET_RANGE and STOP_LIMIT order. |
| optional | string | label | User-specified label. MaxLength = 100. |
| optional | int64 | positionId | Reference to the existing position if the Order is intended to modify it. |
| optional | string | clientOrderId | Optional user-specific clientOrderId (similar to FIX ClOrderID). MaxLength=50. |
| optional | int64 | relativeStopLoss | Relative Stop Loss that can be specified instead of the absolute as one. Specified in 1/100'000 of unit of a price. For BUY stopLoss = entryPrice - relativeStopLoss, for SELL stopLoss = entryPrice + relativeStopLoss. |
| optional | int64 | relativeTakeProfit | Relative Take Profit that can be specified instead of the absolute one. Specified in 1/100'000 of unit of a price. For BUY takeProfit = entryPrice + relativeTakeProfit, for SELL takeProfit = entryPrice - relativeTakeProfit. |
| optional | bool | guaranteedStopLoss | If TRUE then stopLoss is guaranteed. Avalible for the French Risk or the Guaranteed Stop Loss Accounts. |
| optional | bool | trailingStopLoss | If TRUE, then the Stop Loss is Trailing. |
| optional | ProtoOAOrderTriggerMethod | stopTriggerMethod | The trigger method for the STOP or the STOP_LIMIT pending orders. |
ProtoOAExecutionEvent
The event that is sent following the successful order accptance or execution by the server. Acts as Response to the ProtoOANewOrderReq, ProtoOACancelOrderReq, ProtoOAAmendOrderReq, ProtoOAAmendPositionSLTPReq, ProtoOAClosePositionReq requests. Also, the event is sent when a Deposit/Withdral took place.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | int64 | ctidTraderAccountId | Unique identifier of the Trader's Account. Used to match Responses to Trader's Accounts. |
| required | ProtoOAExecutionType | executionType | Type of the order operation. For example: ACCEPTED, FILLED, etc. |
| optional | ProtoOAPosition | position | Reference to the position linked with the execution. |
| optional | ProtoOAOrder | order | Reference to the initial order. |
| optional | ProtoOADeal | deal | Reference to the deal (execution). |
| optional | ProtoOABonusDepositWithdraw | bonusDepositWithdraw | Reference to the Bonus Deposit or Withdrawal operation. |
| optional | ProtoOADepositWithdraw | depositWithdraw | Reference to the Deposit or Withdrawal operation. |
| optional | string | errorCode | The name of the ProtoErrorCode or the other custom ErrorCodes (e.g. ProtoCHErrorCode). |
| optional | bool | isServerEvent | If TRUE, then the event is generated as a result of Server logic instead of the Trader's request (e.g. Stop-out). |
ProtoOACancelOrderReq
Request for cancelling the existing pending orders. Allowed only if the accessToken field has the "trade" permissions for the Trading Account.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | int64 | ctidTraderAccountId | Unique identifier of the Trader's Account. Used to match Responses to Trader's Accounts. |
| required | int64 | orderId | The unique ID of an order to be canceled. |
ProtoOAAmendOrderReq
Request for amending an existing pending order. Allowed only if the accessToken has "trade" permissions for the Trading Account.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | int64 | ctidTraderAccountId | The unique Trader's Account ID used to match the responses to the Trader's Account. |
| required | int64 | orderId | The ID of the order to amend. |
| optional | int64 | volume | Volume represented in 0.01 of a unit (e.g. cents). |
| optional | double | limitPrice | The Limit Price, can be specified for the LIMIT order only. |
| optional | double | stopPrice | The Stop Price, can be specified for the STOP and the STOP_LIMIT orders. |
| optional | int64 | expirationTimestamp | The exact Order expiration time. Should be set for the Good Till Date orders. |
| optional | double | stopLoss | The absolute Stop Loss price (1.23456 for example). Not supported for the MARKER orders. |
| optional | double | takeProfit | The absolute Take Profit price (1.23456 for example). Not supported for the MARKER orders. |
| optional | int32 | slippageInPoints | Slippage distance for the MARKET_RANGE and the STOP_LIMIT orders. |
| optional | int64 | relativeStopLoss | The relative Stop Loss can be specified instead of the absolute one. Sepcified in 1/100'000 of a unit of price. For BUY stopLoss = entryPrice - relativeStopLoss, for SELL stopLoss = entryPrice + relativeStopLoss. |
| optional | int64 | relativeTakeProfit | The relative Take Profit can be specified instead of the absolute one. Specified in 1/100'000 of a unit of price. For BUY takeProfit = entryPrice + relativeTakeProfit, for SELL takeProfit = entryPrice - relativeTakeProfit. |
| optional | bool | guaranteedStopLoss | If TRUE then the Stop Loss is guaranteed. Available for the French Risk or the Guaranteed Stop Loss Accounts. |
| optional | bool | trailingStopLoss | If TRUE then the Trailing Stop Loss is applied. |
| optional | ProtoOAOrderTriggerMethod | stopTriggerMethod | Trigger method for the STOP or the STOP_LIMIT pending orders. |
ProtoOAAmendPositionSLTPReq
Request for amending StopLoss and TakeProfit for existing position. Allowed only if the accessToken has the "trade" permissions for the Trading Account.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | int64 | ctidTraderAccountId | Unique identifier of the Trader's Account. Used to match Responses to Trader's Accounts. |
| required | int64 | positionId | The unique ID of the position to amend. |
| optional | double | stopLoss | The absolute Stop Loss price (e.g.: 1.23456). |
| optional | double | takeProfit | The absolute Take Profit price (e.g.: 1.26543). |
| optional | bool | guaranteedStopLoss | If TRUE, then the Stop Loss is guaranteed. Available for the French Risk or the Guaranteed Stop Loss Accounts. |
| optional | bool | trailingStopLoss | If TRUE, then the Trailing Stop Loss is applied. |
| optional | ProtoOAOrderTriggerMethod | topLossTriggerMethod | The Stop trigger method for the Stop Loss or the Take Profit orders. |
ProtoOAClosePositionReq
Request for closing an existing positions. Allowed only if the accessToken has the "trade" permissions for the Trading Account.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | int64 | ctidTraderAccountId | The unique Trader's Account ID used to match the responses to the Trader's Account. |
| required | int64 | positionId | The unique ID of the position to close. |
| required | int64 | volume | Volume to close, represented in 0.01 of a unit (e.g. cents). |
ProtoOATrailingSLChangedEvent
Event that occurs when the the Trailing Stop Loss level has changed due to the price level changes.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | int64 | ctidTraderAccountId | Unique identifier of the Trader's Account. Used to match Responses to Trader's Accounts. |
| required | int64 | positionId | The unique ID of the position to close. |
| required | int64 | orderId | The unique ID of the order. |
| required | double | stopPrice | New value of the Stop Loss price. |
| required | int64 | utcLastUpdateTimestamp | The exact UTC time when the Stop Loss was updated. |
ProtoOAAssetListReq
The request for the list of assets available for the Trader's Account.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | int64 | ctidTraderAccountId | Unique identifier of the Trader's Account. Used to match Responses to Trader's Accounts. |
ProtoOAAssetListRes
Responce to the ProtoOAAssetListReq request.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | int64 | ctidTraderAccountId | Unique identifier of the Trader's Account. Used to match Responses to Trader's Accounts. |
| repeated | ProtoOAAsset | asset | The list of assets. |
ProtoOASymbolsListReq
Request for the list of symbols available on the Server of the Trader's Account.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | int64 | ctidTraderAccountId | Unique identifier of the Trader's Account. Used to match Responses to Trader's Accounts. |
ProtoOASymbolsListRes
Responce to the ProtoOASymbolsListReq request.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | int64 | ctidTraderAccountId | Unique identifier of the Trader's Account. Used to match Responses to Trader's Accounts. |
| repeated | ProtoOALightSymbol | symbol | The list of symbols. |
ProtoOASymbolByIdReq
Request for getting a full Symbol entity.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | int64 | ctidTraderAccountId | Unique identifier of the Trader's Account. Used to match Responses to Trader's Accounts. |
| repeated | int64 | symbolId | Unique identifier of the Symbol in cTrader platform. |
ProtoOASymbolByIdRes
Response to the ProtoOASymbolByIdReq request.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | int64 | ctidTraderAccountId | Unique identifier of the Trader's Account. Used to match Responses to Trader's Accounts. |
| repeated | ProtoOASymbol | symbol | Symbol entity with the full set of fields. |
ProtoOASymbolsForConversionReq
A request for getting the conversion chain between two assets that consist of several symbols. Use when no direct quote is available.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | int64 | ctidTraderAccountId | Unique identifier of the Trader's Account. Used to match Responses to Trader's Accounts. |
| required | int64 | firstAssetId | The ID of the first asset in the conversation chain. |
| required | int64 | lastAssetId | The ID of the last asset in the conversation chain. |
ProtoOASymbolsForConversionRes
The response to the ProtoOASymbolsForConversionReq request.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | int64 | ctidTraderAccountId | Unique identifier of the Trader's Account. Used to match Responses to Trader's Accounts. |
| repeated | ProtoOALightSymbol | symbol | Conversion chain of the symbols (e.g. EUR/USD, USD/JPY, GBP/JPY -> EUR/GBP). |
ProtoOASymbolChangedEvent
Event that is sent when the symbol is changed on the Server side.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | int64 | ctidTraderAccountId | The unique Trader's Account ID used to match the responses to the Trader's Account. |
| repeated | int64 | symbolId | A unique identifier of the Symbol in cTrader platform. |
ProtoOAAssetClassListReq
Request for a list of asset classes available for the trader's account.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | int64 | ctidTraderAccountId | A unique identifier of the Trader's Account. Used to match responses to Trader's Accounts. |
ProtoOAAssetClassListRes
The response to the ProtoOAAssetListReq request.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | int64 | ctidTraderAccountId | The unique Trader's Account ID used to match the responses to the Trader's Account. |
| repeated | ProtoOAAssetClass | assetClass | List of the asset classes. |
ProtoOATraderReq
Request for getting data of Trader's Account.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | int64 | ctidTraderAccountId | The unique Trader's Account ID used to match the responses to the Trader's Account. |
ProtoOATraderRes
Response to the ProtoOATraderReq request.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | int64 | ctidTraderAccountId | The unique Trader's Account ID used to match the responses to the Trader's Account. |
| required | ProtoOATrader | trader | The Trader account information. |
ProtoOATraderUpdatedEvent
Event that is sent when a Trader is updated on Server side.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | int64 | ctidTraderAccountId | The unique Trader's Account ID used to match the responses to the Trader's Account. |
| required | ProtoOATrader | trader | The Trader account information. |
ProtoOAReconcileReq
Request for getting Trader's current open positions and pending orders data.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | int64 | ctidTraderAccountId | The unique Trader's Account ID used to match the responses to the Trader's Account. |
ProtoOAReconcileRes
The response to the ProtoOAReconcileReq request.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | int64 | ctidTraderAccountId | The unique Trader's Account ID used to match the responses to the Trader's Account. |
| repeated | ProtoOAPosition | position | The list of trader's account open positions. |
| repeated | ProtoOAOrder | order | The list of trader's account pending orders. |
ProtoOAOrderErrorEvent
Event that is sent when errors occur during the order requests.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | int64 | ctidTraderAccountId | The unique Trader's Account ID used to match the responses to the Trader's Account. |
| required | string | errorCode | The name of the ProtoErrorCode or the other custom ErrorCodes (e.g. ProtoCHErrorCode). |
| optional | int64 | orderId | The unique ID of the order. |
| optional | int64 | positionId | The unique ID of the position. |
| optional | string | description | The error description. |
ProtoOADealListReq
Request for getting Trader's deals historical data (execution details).
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | int64 | ctidTraderAccountId | The unique Trader's Account ID used to match the responses to the Trader's Account. |
| required | int64 | fromTimestamp | The UNIX time from which the search starts >=0 (1-1-1970). Validation: toTimestamp - fromTimestamp \<= 604800000 (1 week). |
| required | int64 | toTimestamp | The UNIX time where to stop searching \<= 2147483646000 (19-1-2038). |
| optional | int32 | maxRows | The maximum number of the deals to return. |
ProtoOADealListRes
The response to the ProtoOADealListRes request.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | int64 | ctidTraderAccountId | The unique Trader's Account ID used to match the responses to the Trader's Account. |
| repeated | ProtoOADeal | deal | The list of the deals. |
| repeated | bool | hasMore | If TRUE then the response will provide more than 10000 deals. |
ProtoOAExpectedMarginReq
Request for getting the margin estimate. Can be used before sending a new order request.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | int64 | ctidTraderAccountId | The unique Trader's Account ID used to match the responses to the Trader's Account. |
| required | int64 | symbolId | A unique identifier of the Symbol in cTrader platform. |
| repeated | int64 | volume | Volume represented in 0.01 of a unit (e.g. cents). |
ProtoOAExpectedMarginRes
The response to the ProtoOAExpectedMarginReq request.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | int64 | ctidTraderAccountId | The unique Trader's Account ID used to match the responses to the Trader's Account. |
| repeated | ProtoOAExpectedMargin | margin | The buy and sell margin estimate. |
ProtoOAMarginChangedEvent
Event that is sent when the margin allocated to a specific position is changed.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | int64 | ctidTraderAccountId | The unique Trader's Account ID used to match the responses to the Trader's Account. |
| required | uint64 | positionId | The unique ID of the position. |
| required | uint64 | usedMargin | The new value of the margin used. |
ProtoOACashFlowHistoryListReq
Request for getting Trader's historical data of deposits and withdrawals.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | int64 | ctidTraderAccountId | The unique Trader's Account ID used to match the responses to the Trader's Account. |
| required | int64 | fromTimestamp | The exact UNIX time from which the search starts >=0 (1-1-1970). Validation: toTimestamp - fromTimestamp \<= 604800000 (1 week). |
| required | int64 | toTimestamp | The exact UNIX time where to stop searching \<= 2147483646000 (19-1-2038). |
ProtoOACashFlowHistoryListRes
Response to the ProtoOACashFlowHistoryListReq request.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | int64 | ctidTraderAccountId | The unique Trader's Account ID used to match the responses to the Trader's Account. |
| repeated | ProtoOADepositWithdraw | depositWithdraw | The list of deposit and withdrawal operations. |
ProtoOAGetAccountListByAccessTokenReq
Request for getting the list of granted trader's account for the access token.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | string | accessToken | The Access Token issued for providing access to the Trader's Account. |
ProtoOAGetAccountListByAccessTokenRes
Response to the ProtoOAGetAccountListByAccessTokenReq request.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | string | accessToken | The Access Token issued for providing access to the Trader's Account. |
| optional | ProtoOAClientPermissionScope | permissionScope | The sco0pe of permissions - SCOPE_VIEW or SCOPE_TRADE. |
| repeated | ProtoOACtidTraderAccount | ctidTraderAccountIds | The list of the accounts IDs. |
Quotes
ProtoOASubscribeSpotsReq
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | int64 | ctidTraderAccountId | The unique Trader's Account ID used to match the responses to the Trader's Account. |
| repeated | int64 | symbolId | The unique identifier of the Symbol in cTrader platform. |
ProtoOASubscribeSpotsRes
Response to the ProtoOASubscribeSpotsReq request.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | int64 | ctidTraderAccountId | The unique Trader's Account ID used to match the responses to the Trader's Account. |
ProtoOAUnsubscribeSpotsReq
Request for unsubscribing from the spot events of the specified symbol.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | int64 | ctidTraderAccountId | The unique Trader's Account ID used to match the responses to the Trader's Account. |
| repeated | int64 | symbolId | The unique identifier of the Symbol in cTrader platform. |
ProtoOAUnsubscribeSpotsRes
Response to the ProtoOASubscribeSpotsRes request.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | int64 | ctidTraderAccountId | The unique Trader's Account ID used to match the responses to the Trader's Account. |
ProtoOASpotEvent
Event that is sent when a new spot event is generated on the server side. Requires subscription on the spot events, see ProtoOASubscribeSpotsReq.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | int64 | ctidTraderAccountId | The unique Trader's Account ID used to match the responses to the Trader's Account. |
| required | int64 | symbolId | Unique identifier of the Symbol in cTrader platform. |
| optional | uint64 | bid | Bid price. |
| optional | uint64 | ask | Ask price. |
| repeated | ProtoOATrendbar | trendbar | Returns live trend bar. Requires subscription on the trend bars. |
ProtoOASubscribeLiveTrendbarReq
Request for subscribing for live trend bars. Requires subscription on the spot events, see ProtoOASubscribeSpotsReq.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | int64 | ctidTraderAccountId | The unique Trader's Account ID used to match the responses to the Trader's Account. |
| required | ProtoOATrendbarPeriod | period | Specifies period of trend bar series (e.g. M1, M10, etc.). |
| repeated | int64 | symbolId | The unique identifier of the Symbol in cTrader platform. |
ProtoOAUnsubscribeLiveTrendbarReq
Request for unsubscribing from the live trend bars.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | int64 | ctidTraderAccountId | The unique Trader's Account ID used to match the responses to the Trader's Account. |
| required | ProtoOATrendbarPeriod | period | Specifies period of trend bar series (e.g. M1, M10, etc.). |
| repeated | int64 | symbolId | The unique identifier of the Symbol in cTrader platform. |
ProtoOAGetTrendbarsReq
Request for getting historical trend bars for the symbol.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | int64 | ctidTraderAccountId | The unique Trader's Account ID used to match the responses to the Trader's Account. |
| required | int64 | fromTimestamp | 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). |
| required | int64 | toTimestamp | The exact time of finishing the search in milliseconds. Smaller or equal to 2147483646000 (19-1-2038). |
| required | ProtoOATrendbarPeriod | period | Specifies period of trend bar series (e.g. M1, M10, etc.). |
| required | int64 | symbolId | Unique identifier of the Symbol in cTrader platform. |
ProtoOAGetTrendbarsRes
Response to the ProtoOAGetTrendbarsReq request.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | int64 | ctidTraderAccountId | The unique Trader's Account ID used to match the responses to the Trader's Account. |
| required | ProtoOATrendbarPeriod | period | Specifies period of trend bar series (e.g. M1, M10, etc.). |
| required | int64 | timestamp | Equals to toTimestamp from the request. |
| repeated | int64 | imbolId | Unique identifier of the Symbol in cTrader platform. |
ProtoOAGetTickDataReq
Request for getting historical tick data for the symbol.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | int64 | ctidTraderAccountId | The unique Trader's Account ID used to match the responses to the Trader's Account. |
| required | int64 | symbolId | The unique identifier of the Symbol in cTrader platform. |
| repeated | ProtoOAQuoteType | type | Bid/Ask (1/2). |
| required | int64 | fromTimestamp | 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). |
| required | int64 | toTimestamp | The exact time of finishing the search in milliseconds \<= 2147483646000 (19-1-2038). |
ProtoOAGetTickDataRes
Response to the ProtoOAGetTickDataReq request.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | int64 | ctidTraderAccountId | The unique Trader's Account ID used to match the responses to the Trader's Account. |
| repeated | ProtoOATickData | tickData | The list of ticks. |
| required | bool | hasMore | 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. |
End Quotes
ProtoOAGetCtidProfileByTokenReq
Request for getting details of Trader's profile. Limited due to GDRP requirements.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | string | accessToken | The Access Token issued for providing access to the Trader's Account. |
ProtoOAGetCtidProfileByTokenRes
Response to the ProtoOAGetCtidProfileByTokenReq request.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | ProtoOACtidProfile | profile | Trader's profile. |
ProtoOADepthEvent
Event that is sent when the structure of the depth of market is changed. Requires subscription on the depth of markets for the symbol, see ProtoOASubscribeDepthQuotesReq.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | int64 | ctidTraderAccountId | The unique Trader's Account ID used to match the responses to the Trader's Account. |
| required | int64 | symbolId | The unique identifier of the Symbol in cTrader platform. |
| repeated | ProtoOADepthQuote | newQuotes | The list of changes in the depth of market quotes. |
| repeated | uint64 | deletedQuotes | The list of quotes to delete. |
ProtoOASubscribeDepthQuotesReq
Request for subscribing on depth of market of the specified symbol.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | int64 | ctidTraderAccountId | The unique Trader's Account ID used to match the responses to the Trader's Account. |
| required | int64 | symbolId | The unique identifier of the Symbol in cTrader platform. |
ProtoOASubscribeDepthQuotesRes
Response to the ProtoOASubscribeDepthQuotesReq request.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | int64 | ctidTraderAccountId | The unique Trader's Account ID used to match the responses to the Trader's Account. |
ProtoOAUnsubscribeDepthQuotesReq
Request for unsubscribing from the depth of market of the specified symbol.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | int64 | ctidTraderAccountId | The unique Trader's Account ID used to match the responses to the Trader's Account. |
| required | int64 | symbolId | The unique identifier of the Symbol in cTrader platform. |
ProtoOAUnsubscribeDepthQuotesRes
Response to the ProtoOAUnsubscribeDepthQuotesReq request.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | int64 | ctidTraderAccountId | The unique Trader's Account ID used to match the responses to the Trader's Account. |
ProtoOAAccountLogoutReq
Request to logout a trading account and close the session. Requires established authorized connection with the client application.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | int64 | ctidTraderAccountId | The unique identifier of the Trader's Account in cTrader platform. |
ProtoOAAccountLogoutRes
Response to the ProtoOATraderLogoutReq request.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoOAPayloadType | payloadType | |
| required | int64 | ctidTraderAccountId | The unique identifier of the Trader's Account in cTrader platform. |