Broker API HubMenu

cTrader ProtoOAGetTickDataReq

messageProtoOAGetTickDataReqcTrader Open APIpayloadType 2145Historical data

Asks for historical ticks of one symbol, bid or ask, in a period of time.

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.

No JSON sample is given here. A required field of this message is an enumeration, and Spotware's page on sending and receiving JSON does not say how an enumeration value is written in JSON.

The message

Name
ProtoOAGetTickDataReq
Direction
Request, sent by the client
Payload type
PROTO_OA_GET_TICKDATA_REQ, number 2145. This number is what identifies the message on the wire.

Fields

NameTypeDescription
payloadTypeProtoOAPayloadTypeIdentifies the message. Its default in the definition is PROTO_OA_GET_TICKDATA_REQ, which is number 2145.
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.
symbolIdrequiredint64The symbol, by its id on the cTrader platform. Ids come from the symbol list.
typerequiredProtoOAQuoteTypeWhich side to return, as a value of ProtoOAQuoteType: bid is 1 and ask is 2.
fromTimestampint64The start of the period, as Unix time in milliseconds. Not below zero, which is 1 January 1970.
toTimestampint64The end of the period, as Unix time in milliseconds. Not above 2147483646000, which the definition dates to 19 January 2038.

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