GetBarsRequest

Documentation / @elitechart/elitechart / GetBarsRequest

Defined in: core/dist/index.d.ts:273

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: core/dist/index.d.ts:276

resolution

code

readonly resolution: Resolution;

Defined in: core/dist/index.d.ts:275

signal?

code

readonly optional signal?: AbortSignal;

Defined in: core/dist/index.d.ts:278

symbol

code

readonly symbol: SymbolInfo;

Defined in: core/dist/index.d.ts:274

to

code

readonly to: TimestampMs;

Defined in: core/dist/index.d.ts:277