Skip to content

Common Messages

Top

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