View Source XtbClient.Messages.ChartRange.Query (XtbClient v0.1.1)
Parameters for chart range query.
parameters
Parameters
start
start of chart block (rounded down to the nearest interval and excluding),end
end of chart block (rounded down to the nearest interval and excluding),period
period, seeXtbClient.Messages.Period
,symbol
symbol name,ticks
number of ticks needed, this field is optional, please read the description below.
ticks
Ticks
Ticks field - if ticks is not set or value is 0
, getChartRangeRequest
works as before (you must send valid start and end time fields).
If ticks value is not equal to 0
, field end is ignored.
If ticks >0
(e.g. N
) then API returns N
candles from time start.
If ticks <0
then API returns N
candles to time start.
It is possible for API to return fewer chart candles than set in tick field.
Link to this section Summary
Link to this section Types
@type t() :: %XtbClient.Messages.ChartRange.Query{ end: integer(), period: XtbClient.Messages.Period.t(), start: integer(), symbol: binary(), ticks: integer() }