Open API Common Messages .proto file
ProtoMessage
The protobuf message.
| Required | Type | Field Name | Description |
|---|---|---|---|
| required | uint32 | payloadType | Contains the ID of ProtoPayloadType or other custom PayloadTypes (e.g. ProtoOAPayloadType). |
| optional | bytes | payload | Serialized protobuf message that corresponds to payloadType. |
| optional | string | clientMsgId | The request message ID, assigned by the client that will be returned in the response. |
ProtoErrorRes
The error messages.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoPayloadType | payloadType | The unique identifier of the request, response or event command. |
| required | string | errorCode | Contains the name of ProtoErrorCode or other custom ErrorCodes (e.g. ProtoCHErrorCode). |
| optional | string | description | Error description. |
| optional | uint64 | maintenanceEndTimestamp | Epoch timestamp in second. |
ProtoHeartbeatEvent
The event that is sent from the Open API proxy and can be used as criteria that connection is healthy when no other messages are sent by cTrader platform. The 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.
| Required | Type | Field Name | Description |
|---|---|---|---|
| optional | ProtoPayloadType | payloadType | The unique identifier of the request, response or event command. |