GetBarsRequest

Documentation / @elitechart/core / GetBarsRequest

Request shape for a one-shot historical bars fetch. The optional signal lets the caller cancel an in-flight request when the user navigates away.

Example

code

const req: GetBarsRequest = {
  symbol,
  resolution: { kind: 'minutes', value: 1 },
  from: asTimestampMs(Date.now() - 86_400_000),
  to: asTimestampMs(Date.now()),
};

Properties

from

code

readonly from: TimestampMs;

Defined in: data/types.ts:172

resolution

code

readonly resolution: Resolution;

Defined in: data/types.ts:171

signal?

code

readonly optional signal?: AbortSignal;

Defined in: data/types.ts:174

symbol

code

readonly symbol: SymbolInfo;

Defined in: data/types.ts:170

to

code

readonly to: TimestampMs;

Defined in: data/types.ts:173