Broker API HubMenu

cTrader ProtoOAGetTrendbarsRes

messageProtoOAGetTrendbarsRescTrader Open APIpayloadType 2138Historical data

Returns the historical bars that were asked for.

Risk warning: CFDs and spread bets are complex instruments and come with a high risk of losing money rapidly due to leverage. You can lose money on these products, and each provider publishes its own loss figure under FCA rules. You should consider whether you understand how they work and whether you can afford to take the high risk of losing your money. Automated and API trading can amplify losses through bugs, connectivity failures and runaway orders.

Independent and unofficialhelp.ctrader.comchecked The definition file it was checked against

This is a message of the cTrader Open API, not an HTTP endpoint. It has no method and no path: it is sent over an open TCP or WebSocket connection, as Protocol Buffers or as JSON.

The documentation page's table lists timestamp (int64, optional), which the definition file does not hold. This record follows the definition file.

The message

Name
ProtoOAGetTrendbarsRes
Direction
Response, sent by the server
Payload type
PROTO_OA_GET_TRENDBARS_RES, number 2138. This number is what identifies the message on the wire.

Fields

NameTypeDescription
payloadTypeProtoOAPayloadTypeIdentifies the message. Its default in the definition is PROTO_OA_GET_TRENDBARS_RES, which is number 2138.
ctidTraderAccountIdrequiredint64The account the message is about, by its cTrader account id. Responses and events carry the same id, which is how a program holding several accounts on one connection tells them apart.
periodrequiredProtoOATrendbarPeriodThe bar size, as a value of the ProtoOATrendbarPeriod enumeration, for example M1.
trendbarrepeated ProtoOATrendbarThe bars, one ProtoOATrendbar for each.
symbolIdint64The symbol the bars belong to.
hasMoreboolTrue when more records match the request than this one response holds.

Limits that apply at cTrader Open API

LimitValueScopeSource
Requests a second, not historical data50Per connection, requests that are not for historical datahelp.ctrader.comchecked
Requests a second, historical data5Per connection, historical data requests onlyhelp.ctrader.comchecked