Table of Contents

Class CandleSeriesRequest

Namespace
ATAS.Indicators
Assembly
ATAS.Indicators.dll

Describes a candle series to request: the timeframe and, optionally, another instrument.

Added in ATAS 8.0.15.

public class CandleSeriesRequest
Inheritance
object
CandleSeriesRequest
Extension Methods

Constructors

CandleSeriesRequest() 

public CandleSeriesRequest()

Properties

DaysToLoad

History depth in trading days. Clamped by the host (1..30) and by the tariff.

public int DaysToLoad { get; init; }

Property Value

int

ExoticTimeFrame

A parameter-heavy aggregation type (RangeX/RangeXV/RangeZ/RangeUS/ReversalX). When set, TimeFrame is ignored.

public ExoticCandleSeriesTimeFrame? ExoticTimeFrame { get; init; }

Property Value

ExoticCandleSeriesTimeFrame

Instrument

The instrument; null or empty means the chart's instrument. A plain string (instrument code) converts implicitly.

public CandleSeriesInstrument? Instrument { get; init; }

Property Value

CandleSeriesInstrument?

TimeFrame

The aggregation timeframe. Required unless ExoticTimeFrame is set.

public CandleSeriesTimeFrame TimeFrame { get; init; }

Property Value

CandleSeriesTimeFrame

TradingSessionId

Trading session id (the same ids the chart's session selector uses, including custom sessions); null means the instrument's default session.

public long? TradingSessionId { get; init; }

Property Value

long?

Methods

ToString()

Returns a short description of the request for logs: the instrument (<chart> when not set) followed by ExoticTimeFrame when set, otherwise TimeFrame.

public override string ToString()

Returns

string

The description, e.g. ESZ6 M5.