Skip to content
EliteChart

Datafeed

Documentation

Documentation / @elitechart/elitechart / Datafeed

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

Datafeed contract. Implementations own transport (REST, WebSocket, static JSON, etc.).

Example

code
const feed: Datafeed = {
  async getBars({ symbol, resolution, from, to }) { return []; },
  subscribe({ symbol, resolution }, onBar) { return () => {}; },
};

Methods

getBars()

code
getBars(req): Promise<readonly Bar[]>;

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

Parameters

req

GetBarsRequest

Returns

Promise<readonly Bar[]>

resolveSymbol()?

code
optional resolveSymbol(symbolId): Promise<SymbolInfo>;

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

Parameters

symbolId

string

Returns

Promise<SymbolInfo>

searchSymbols()?

code
optional searchSymbols(query, opts?): Promise<readonly SymbolInfo[]>;

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

Parameters

query

string

opts?

SearchOptions

Returns

Promise<readonly SymbolInfo[]>

subscribe()

code
subscribe(req, onBar): () => void;

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

Parameters

req

SubscribeRequest

onBar

(bar) => void

Returns

() => void