Lumen ChartsLumen Charts
Api

PineChartRuntimeApi

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.

chartEpoch

chartEpoch(): number;

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

compile

compile(
    source: string,
    options?: { signal?: AbortSignal },
  ): Promise<PineScriptCompileResult>;

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

ParameterTypeRequired
sourcestringYes
options{ signal?: AbortSignal }No

run

run(input: {
    source: string;
    sourceHash: string;
    studyId?: string | null;
  }): Promise<{
    chartEpoch: number;
    compile: PineScriptCompileResult;
    sourceHash: string;
    strategyReportBaseline: {
      revision: number;
      studyId: string | null;
    };
    studyId: string;
  }>;

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

ParameterTypeRequired
input{ source: string; sourceHash: string; studyId?: string &#124; null; }Yes

remove

remove(studyId: string): Promise<void>;

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

ParameterTypeRequired
studyIdstringYes

getExecutionProgress

getExecutionProgress(studyId: string): PineExecutionProgress | null;

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

ParameterTypeRequired
studyIdstringYes

getStrategyReport

getStrategyReport(studyId: string): PineStrategyReport | null;

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

ParameterTypeRequired
studyIdstringYes

getStrategySnapshot

getStrategySnapshot(studyId: string): {
    report: PineStrategyReport;
    revision: number;
  } | null;

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

ParameterTypeRequired
studyIdstringYes

getLogSnapshot

getLogSnapshot(studyId: string): { logs: PineLogPage; revision: number } | null;

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

ParameterTypeRequired
studyIdstringYes

subscribeLogs

subscribeLogs(studyId: string, listener: (change: { revision: number; logs: PineLogPage | null }) => void): () => void;

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

ParameterTypeRequired
studyIdstringYes
listener(change: { revision: number; logs: PineLogPage &#124; null }) => voidYes

readLogPage

readLogPage(studyId: string, cursor: PineLogCursor, options?: { signal?: AbortSignal }): Promise<PineLogPage>;

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

ParameterTypeRequired
studyIdstringYes
cursorPineLogCursorYes
options{ signal?: AbortSignal }No

focusLogBar

focusLogBar(studyId: string, barOpenTimeMs: number): Promise<void>;

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

ParameterTypeRequired
studyIdstringYes
barOpenTimeMsnumberYes

subscribeExecutionProgress

subscribeExecutionProgress(
    studyId: string,
    listener: (progress: PineExecutionProgress) => void,
  ): () => void;

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

ParameterTypeRequired
studyIdstringYes
listener(progress: PineExecutionProgress) => voidYes

subscribeStrategyReport

subscribeStrategyReport(
    studyId: string,
    listener: (change: {
      revision: number;
      report: PineStrategyReport;
    }) => void,
  ): () => void;

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

ParameterTypeRequired
studyIdstringYes
listener(change: { revision: number; report: PineStrategyReport; }) => voidYes

focusStrategyTrade

focusStrategyTrade(studyId: string, tradeId: string): Promise<void>;

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

ParameterTypeRequired
studyIdstringYes
tradeIdstringYes

On this page