Api

IDatafeedChartApi

Download Markdown

Integration guide · Reference index

Public contract reference. This declaration describes types and callback shapes; availability is constrained by the linked integration guide and the runtime capability. Legacy product-specific fields are not a promise of implementation.

footprint

footprint?: FootprintProvider;

Optional rebuild volume footprint source. Beta. This may change in a later release.

getMarks

getMarks?(
    symbolInfo: LibrarySymbolInfo,
    from: number,
    to: number,
    onDataCallback: GetMarksCallback<Mark>,
    resolution: ResolutionString,
  ): void;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`symbolInfo`	`LibrarySymbolInfo`	Yes
`from`	`number`	Yes
`to`	`number`	Yes
`onDataCallback`	`GetMarksCallback<Mark>`	Yes
`resolution`	`ResolutionString`	Yes

getTimescaleMarks

getTimescaleMarks?(
    symbolInfo: LibrarySymbolInfo,
    from: number,
    to: number,
    onDataCallback: GetMarksCallback<TimescaleMark>,
    resolution: ResolutionString,
  ): void;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`symbolInfo`	`LibrarySymbolInfo`	Yes
`from`	`number`	Yes
`to`	`number`	Yes
`onDataCallback`	`GetMarksCallback<TimescaleMark>`	Yes
`resolution`	`ResolutionString`	Yes

getServerTime

getServerTime?(callback: ServerTimeCallback): void;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`callback`	`ServerTimeCallback`	Yes

searchSymbols

searchSymbols(
    userInput: string,
    exchange: string,
    symbolType: string,
    onResult: SearchSymbolsCallback,
  ): void;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`userInput`	`string`	Yes
`exchange`	`string`	Yes
`symbolType`	`string`	Yes
`onResult`	`SearchSymbolsCallback`	Yes

resolveSymbol

resolveSymbol(
    symbolName: string,
    onResolve: ResolveCallback,
    onError: ErrorCallback,
    extension?: SymbolResolveExtension,
  ): void;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`symbolName`	`string`	Yes
`onResolve`	`ResolveCallback`	Yes
`onError`	`ErrorCallback`	Yes
`extension`	`SymbolResolveExtension`	No

getBars

getBars(
    symbolInfo: LibrarySymbolInfo,
    resolution: ResolutionString,
    periodParams: PeriodParams,
    onResult: HistoryCallback,
    onError: ErrorCallback,
  ): void;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`symbolInfo`	`LibrarySymbolInfo`	Yes
`resolution`	`ResolutionString`	Yes
`periodParams`	`PeriodParams`	Yes
`onResult`	`HistoryCallback`	Yes
`onError`	`ErrorCallback`	Yes

subscribeBars

subscribeBars(
    symbolInfo: LibrarySymbolInfo,
    resolution: ResolutionString,
    onTick: SubscribeBarsCallback,
    listenerGuid: string,
    onResetCacheNeededCallback: () => void,
  ): void;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`symbolInfo`	`LibrarySymbolInfo`	Yes
`resolution`	`ResolutionString`	Yes
`onTick`	`SubscribeBarsCallback`	Yes
`listenerGuid`	`string`	Yes
`onResetCacheNeededCallback`	`() => void`	Yes

unsubscribeBars

unsubscribeBars(listenerGuid: string): void;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`listenerGuid`	`string`	Yes

subscribeDepth

subscribeDepth?(symbol: string, callback: DOMCallback): string;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`symbol`	`string`	Yes
`callback`	`DOMCallback`	Yes

unsubscribeDepth

unsubscribeDepth?(subscriberUID: string): void;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`subscriberUID`	`string`	Yes

getVolumeProfileResolutionForPeriod

getVolumeProfileResolutionForPeriod?(
    currentResolution: ResolutionString,
    from: number,
    to: number,
    symbolInfo: LibrarySymbolInfo,
  ): ResolutionString;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`currentResolution`	`ResolutionString`	Yes
`from`	`number`	Yes
`to`	`number`	Yes
`symbolInfo`	`LibrarySymbolInfo`	Yes

On this page

footprint getMarks getTimescaleMarks getServerTime searchSymbols resolveSymbol getBars subscribeBars unsubscribeBars subscribeDepth unsubscribeDepth getVolumeProfileResolutionForPeriod Related types