MCP Control Reference

The catalog below describes machine-callable controls; the live session and host-owned console remain the authority for targets, grants, and evidence.

Use this catalog to find the control IDs accepted by tradescript_call and the channel IDs accepted by tradescript_subscribe. Control and channel IDs are arguments to those tools, not additional MCP tool names.

• Protocol version: 2.0.0
• Callable controls: 615
• Subscription channels: 38

This catalog describes the available vocabulary. It does not grant access. For each paired session, call tradescript_list_controls and use only the controls returned for the selected target.

Every v2 operation uses one target: { scope: 'session' }, { scope: 'chart', chartId }, or { scope: 'widget', widgetId }. Discover mounted identities with tradescript_get_context; never guess or silently substitute a target.

Find a control or subscription

Search the exact public ID, controller, family, access class, or purpose. Expand only the operation you need. The live tradescript_list_controls result remains the authority for what the paired session can call.

Search this reference

Showing 0 (0 total) operations

Access-class coverage

Access class	Controls
read	202
trade	24
write	389

Family coverage

Family	Controls
account	5
accountView	18
chart	70
chartLayouts	44
chartNavigation	41
chartSettings	40
customization	42
depthLadder	8
drawings	22
emergency	6
indicators	7
leverage	1
marketData	26
news	1
objects	29
options	3
optionsView	5
orderEntry	8
orderFlow	19
orders	10
orderTicket	50
positions	7
replay	13
risk	8
riskPolicy	2
symbolLink	1
terminal	6
terminalLayout	45
trading	20
tradingLogs	1
tradingPreview	4
tradingSession	2
watchlist	6
watchlists	31
workspace	14

For a financial control, decisionReceipt describes risk.getDecisionReceipt(effectiveOperationId) after an applied mutation (mutated: true). always means an exact decision receipt is required, never means the operation is explicitly risk-reducing and no decision receipt is expected, and conditional means the mounted controller resolves one of the listed SDK-owned classes from its typed state or input.

Policy constraints document required input limits and readable-result filters. Apply them exactly as returned by live discovery.

Callable controls

Discover the session-effective descriptor for the same session and target with tradescript_list_controls before using tradescript_call.

accountActionDialog.clearMessagewrite · write

AccountActionDialogControllerApi.clearMessage

Contract	Value
Controller	accountActionDialog
Target scopes	widget
Family	accountView
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · accountActionDialog.current.symbols authority extractor · required when constrained accounts · string · accountActionDialog.current.accounts authority extractor · required when constrained
Revision domains	accountActionDialog
Options index	None

Public SDK signature

clearMessage(options?: AccountActionDialogMutationOptions): boolean

accountActionDialog.closewrite · write

AccountActionDialogControllerApi.close

Contract	Value
Controller	accountActionDialog
Target scopes	widget
Family	accountView
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · accountActionDialog.current.symbols authority extractor · required when constrained accounts · string · accountActionDialog.current.accounts authority extractor · required when constrained
Revision domains	accountActionDialog
Options index	None

Public SDK signature

close(options?: AccountActionDialogMutationOptions): boolean

accountActionDialog.getSnapshotread · read

AccountActionDialogControllerApi.getSnapshot

Contract	Value
Controller	accountActionDialog
Target scopes	widget
Family	account
Implementation	sdk
Permission label	trading.read
Financial risk classes	None
Decision receipt	None
Input constraints	accountActionDialog.getSnapshot.allowedSymbolsAccounts result filter · symbols, accounts accountActionDialog.getSnapshot.allowedResources result filter · resourceIds, resourceKinds accountActionDialog.getSnapshot.tradePolicy result filter · orderTypes, orderSides, timeInForce, positionIds, maxQuantity
Revision domains	None
Options index	None

Public SDK signature

getSnapshot(): AccountActionDialogSnapshot

accountActionDialog.isReadyread · read

AccountActionDialogControllerApi.isReady

Contract	Value
Controller	accountActionDialog
Target scopes	widget
Family	account
Implementation	sdk
Permission label	trading.read
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	None
Options index	None

Public SDK signature

isReady(): boolean

accountActionDialog.openwrite · write

AccountActionDialogControllerApi.open

Contract	Value
Controller	accountActionDialog
Target scopes	widget
Family	accountView
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · accountActionDialog.open.symbols authority extractor · required when constrained accounts · string · accountActionDialog.open.accounts authority extractor · required when constrained resourceIds · string · accountActionDialog.open.resourceIds authority extractor · required when constrained resourceKinds · string · accountActionDialog.open.resourceKinds authority extractor · required when constrained positionIds · string · accountActionDialog.open.positionIds authority extractor · optional when constrained
Revision domains	accountActionDialog
Options index	None

Public SDK signature

open(request: AccountActionDialogRequest, options?: AccountActionDialogMutationOptions): boolean

accountActionDialog.setQuantitywrite · write

AccountActionDialogControllerApi.setQuantity

Contract	Value
Controller	accountActionDialog
Target scopes	widget
Family	orderTicket
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · accountActionDialog.current.symbols authority extractor · required when constrained accounts · string · accountActionDialog.current.accounts authority extractor · required when constrained resourceIds · string · accountActionDialog.setQuantity.resourceIds authority extractor · required when constrained resourceKinds · string · accountActionDialog.setQuantity.resourceKinds authority extractor · required when constrained maxQuantity · finite-number · accountActionDialog.setQuantity.maxQuantity.sourceUnavailable authority extractor · required when constrained; absolute magnitude
Revision domains	accountActionDialog
Options index	None

Public SDK signature

setQuantity(value: string, options?: AccountActionDialogMutationOptions): boolean

accountActionDialog.setStopLosswrite · write

AccountActionDialogControllerApi.setStopLoss

Contract	Value
Controller	accountActionDialog
Target scopes	widget
Family	orderTicket
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · accountActionDialog.current.symbols authority extractor · required when constrained accounts · string · accountActionDialog.current.accounts authority extractor · required when constrained resourceIds · string · accountActionDialog.setStopLoss.resourceIds authority extractor · required when constrained resourceKinds · string · accountActionDialog.setStopLoss.resourceKinds authority extractor · required when constrained
Revision domains	accountActionDialog
Options index	None

Public SDK signature

setStopLoss(value: string, options?: AccountActionDialogMutationOptions): boolean

accountActionDialog.setTakeProfitwrite · write

AccountActionDialogControllerApi.setTakeProfit

Contract	Value
Controller	accountActionDialog
Target scopes	widget
Family	orderTicket
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · accountActionDialog.current.symbols authority extractor · required when constrained accounts · string · accountActionDialog.current.accounts authority extractor · required when constrained resourceIds · string · accountActionDialog.setTakeProfit.resourceIds authority extractor · required when constrained resourceKinds · string · accountActionDialog.setTakeProfit.resourceKinds authority extractor · required when constrained
Revision domains	accountActionDialog
Options index	None

Public SDK signature

setTakeProfit(value: string, options?: AccountActionDialogMutationOptions): boolean

accountActionDialog.submitOrderActiontrade · financial

AccountActionDialogControllerApi.submitOrderAction

Contract	Value
Controller	accountActionDialog
Target scopes	widget
Family	orders
Implementation	sdk
Permission label	trading.write
Financial risk classes	risk-reducing
Decision receipt	never
Input constraints	symbols · string · accountActionDialog.current.symbols authority extractor · required when constrained accounts · string · accountActionDialog.current.accounts authority extractor · required when constrained resourceIds · string · accountActionDialog.submitOrderAction.resourceIds authority extractor · required when constrained resourceKinds · string · accountActionDialog.submitOrderAction.resourceKinds authority extractor · required when constrained
Revision domains	accountActionDialog
Options index	0

Public SDK signature

submitOrderAction(options?: AccountActionDialogMutationOptions): Promise<AccountActionDialogActionOutcome>

accountActionDialog.submitPositionActiontrade · financial

AccountActionDialogControllerApi.submitPositionAction

Contract	Value
Controller	accountActionDialog
Target scopes	widget
Family	positions
Implementation	sdk
Permission label	trading.write
Financial risk classes	risk-reducing, risk-changing
Decision receipt	conditional
Input constraints	symbols · string · accountActionDialog.current.symbols authority extractor · required when constrained accounts · string · accountActionDialog.current.accounts authority extractor · required when constrained resourceIds · string · accountActionDialog.submitPositionAction.resourceIds authority extractor · required when constrained resourceKinds · string · accountActionDialog.submitPositionAction.resourceKinds authority extractor · required when constrained positionIds · string · accountActionDialog.submitPositionAction.positionIds authority extractor · required when constrained
Revision domains	accountActionDialog
Options index	0

Public SDK signature

submitPositionAction(options?: AccountActionDialogMutationOptions): Promise<AccountActionDialogActionOutcome>

accountPanel.clearStatusFilterswrite · write

AccountPanelControllerApi.clearStatusFilters

Contract	Value
Controller	accountPanel
Target scopes	widget
Family	accountView
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	accountPanel
Options index	None

Public SDK signature

clearStatusFilters(options?: AccountPanelMutationOptions): boolean

accountPanel.getSnapshotread · read

AccountPanelControllerApi.getSnapshot

Contract	Value
Controller	accountPanel
Target scopes	widget
Family	account
Implementation	sdk
Permission label	trading.read
Financial risk classes	None
Decision receipt	None
Input constraints	accountPanel.getSnapshot.allowedAccounts result filter · accounts accountPanel.getSnapshot.allowedResources result filter · resourceIds, resourceKinds accountPanel.getSnapshot.tradePolicy result filter · positionIds
Revision domains	None
Options index	None

Public SDK signature

getSnapshot(): AccountPanelSnapshot

accountPanel.isReadyread · read

AccountPanelControllerApi.isReady

Contract	Value
Controller	accountPanel
Target scopes	widget
Family	account
Implementation	sdk
Permission label	trading.read
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	None
Options index	None

Public SDK signature

isReady(): boolean

accountPanel.replaceVisibilityStatewrite · write

AccountPanelControllerApi.replaceVisibilityState

Contract	Value
Controller	accountPanel
Target scopes	widget
Family	accountView
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · accountPanel.replaceVisibilityState.resourceIds authority extractor · required when constrained resourceKinds · string · accountPanel.replaceVisibilityState.resourceKinds authority extractor · required when constrained
Revision domains	accountPanel
Options index	None

Public SDK signature

replaceVisibilityState(
    visibilityState: Readonly<Record<string, Readonly<Record<string, boolean>>>>,
    options?: AccountPanelMutationOptions,
  ): boolean

accountPanel.requestExportwrite · write

AccountPanelControllerApi.requestExport

Contract	Value
Controller	accountPanel
Target scopes	widget
Family	accountView
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · accountPanel.requestExport.resourceIds authority extractor · required when constrained resourceKinds · string · accountPanel.requestExport.resourceKinds authority extractor · required when constrained
Revision domains	accountPanel
Options index	None

Public SDK signature

requestExport(pageId?: string, options?: AccountPanelMutationOptions): AccountPanelExportIntent

accountPanel.selectAccountwrite · write

AccountPanelControllerApi.selectAccount

Contract	Value
Controller	accountPanel
Target scopes	widget
Family	accountView
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	accounts · string · accountPanel.selectAccount.accounts authority extractor · required when constrained
Revision domains	accountPanel
Options index	None

Public SDK signature

selectAccount(accountId: string, options?: AccountPanelMutationOptions): Promise<boolean>

accountPanel.setActivePagewrite · write

AccountPanelControllerApi.setActivePage

Contract	Value
Controller	accountPanel
Target scopes	widget
Family	accountView
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · accountPanel.setActivePage.resourceIds authority extractor · required when constrained resourceKinds · string · accountPanel.setActivePage.resourceKinds authority extractor · required when constrained
Revision domains	accountPanel
Options index	None

Public SDK signature

setActivePage(pageId: string, options?: AccountPanelMutationOptions): boolean

accountPanel.setColumnVisibilitywrite · write

AccountPanelControllerApi.setColumnVisibility

Contract	Value
Controller	accountPanel
Target scopes	widget
Family	accountView
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · accountPanel.setColumnVisibility.resourceIds authority extractor · required when constrained resourceKinds · string · accountPanel.setColumnVisibility.resourceKinds authority extractor · required when constrained
Revision domains	accountPanel
Options index	None

Public SDK signature

setColumnVisibility(
    tableId: string,
    columnId: string,
    visible: boolean,
    options?: AccountPanelMutationOptions,
  ): boolean

accountPanel.setExecutionFocuswrite · write

AccountPanelControllerApi.setExecutionFocus

Contract	Value
Controller	accountPanel
Target scopes	widget
Family	accountView
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · accountPanel.setExecutionFocus.resourceIds authority extractor · required when constrained resourceKinds · string · accountPanel.setExecutionFocus.resourceKinds authority extractor · required when constrained
Revision domains	accountPanel
Options index	None

Public SDK signature

setExecutionFocus(executionId: string | null, options?: AccountPanelMutationOptions): boolean

accountPanel.setPnlDisplayModewrite · write

AccountPanelControllerApi.setPnlDisplayMode

Contract	Value
Controller	accountPanel
Target scopes	widget
Family	accountView
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	accountPanel
Options index	None

Public SDK signature

setPnlDisplayMode(mode: PnlDisplayMode, options?: AccountPanelMutationOptions): boolean

accountPanel.setPositionExpandedwrite · write

AccountPanelControllerApi.setPositionExpanded

Contract	Value
Controller	accountPanel
Target scopes	widget
Family	accountView
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · accountPanel.setPositionExpanded.resourceIds authority extractor · required when constrained resourceKinds · string · accountPanel.setPositionExpanded.resourceKinds authority extractor · required when constrained positionIds · string · args[0] · required when constrained
Revision domains	accountPanel
Options index	None

Public SDK signature

setPositionExpanded(positionId: string, expanded: boolean, options?: AccountPanelMutationOptions): boolean

accountPanel.setPositionModewrite · write

AccountPanelControllerApi.setPositionMode

Contract	Value
Controller	accountPanel
Target scopes	widget
Family	accountView
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	accountPanel
Options index	None

Public SDK signature

setPositionMode(mode: AccountPanelPositionMode, options?: AccountPanelMutationOptions): boolean

accountPanel.setSortStatewrite · write

AccountPanelControllerApi.setSortState

Contract	Value
Controller	accountPanel
Target scopes	widget
Family	accountView
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	accountPanel
Options index	None

Public SDK signature

setSortState(sortState: BrokerAccountPanelSortState | null, options?: AccountPanelMutationOptions): boolean

accountPanel.setStatusFilterwrite · write

AccountPanelControllerApi.setStatusFilter

Contract	Value
Controller	accountPanel
Target scopes	widget
Family	accountView
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	accountPanel
Options index	None

Public SDK signature

setStatusFilter(
    source: AccountPanelStatusFilterSource,
    status: string,
    included: boolean,
    options?: AccountPanelMutationOptions,
  ): boolean

accountPanel.setStatusFilterswrite · write

AccountPanelControllerApi.setStatusFilters

Contract	Value
Controller	accountPanel
Target scopes	widget
Family	accountView
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	accountPanel
Options index	None

Public SDK signature

setStatusFilters(
    source: AccountPanelStatusFilterSource,
    statuses: readonly string[],
    options?: AccountPanelMutationOptions,
  ): boolean

accountPanel.setSummaryFieldVisibilitywrite · write

AccountPanelControllerApi.setSummaryFieldVisibility

Contract	Value
Controller	accountPanel
Target scopes	widget
Family	accountView
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · accountPanel.setSummaryFieldVisibility.resourceIds authority extractor · required when constrained resourceKinds · string · accountPanel.setSummaryFieldVisibility.resourceKinds authority extractor · required when constrained
Revision domains	accountPanel
Options index	None

Public SDK signature

setSummaryFieldVisibility(
    fieldId: string,
    visible: boolean,
    options?: AccountPanelMutationOptions,
  ): boolean

accountPanel.togglePositionExpandedwrite · write

AccountPanelControllerApi.togglePositionExpanded

Contract	Value
Controller	accountPanel
Target scopes	widget
Family	accountView
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · accountPanel.togglePositionExpanded.resourceIds authority extractor · required when constrained resourceKinds · string · accountPanel.togglePositionExpanded.resourceKinds authority extractor · required when constrained positionIds · string · args[0] · required when constrained
Revision domains	accountPanel
Options index	None

Public SDK signature

togglePositionExpanded(positionId: string, options?: AccountPanelMutationOptions): boolean

chart.addAlertwrite · write

ChartApi.addAlert

Contract	Value
Controller	chart
Target scopes	chart
Family	objects
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · chart.addAlert.symbols authority extractor · required when constrained resourceIds · string · chart.addAlert.resourceIds authority extractor · required when constrained resourceKinds · string · chart.addAlert.resourceKinds authority extractor · required when constrained
Revision domains	content
Options index	None

Public SDK signature

(alert: AlertDefinition) => string

chart.addBuiltInIndicatorwrite · write

Add a built-in indicator by catalog id and return the new indicator instance id.

Contract	Value
Controller	chart
Target scopes	chart
Family	indicators
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceKinds · string · chart.addBuiltInIndicator.resourceKinds authority extractor · required when constrained
Revision domains	content
Options index	None

Public SDK signature

(indicatorId: string, options?: AddBuiltInIndicatorOptions) => Promise<string> | string

chart.addComparisonwrite · write

Add a comparison series for another symbol and return its comparison id.

Contract	Value
Controller	chart
Target scopes	chart
Family	objects
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · chart.addComparison.symbols authority extractor · required when constrained resourceIds · string · chart.addComparison.resourceIds authority extractor · required when constrained resourceKinds · string · chart.addComparison.resourceKinds authority extractor · required when constrained
Revision domains	content
Options index	None

Public SDK signature

(input: AddComparisonOptions) => Promise<string> | string

chart.addIndicatorwrite · write

Add a custom indicator definition and return its new indicator instance id.

Contract	Value
Controller	chart
Target scopes	chart
Family	indicators
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · chart.addIndicator.resourceIds authority extractor · required when constrained resourceKinds · string · chart.addIndicator.resourceKinds authority extractor · required when constrained
Revision domains	content
Options index	None

Public SDK signature

(indicator: IndicatorDefinition) => Promise<string> | string

chart.addMarkerwrite · write

Add a chart marker (e.g. a trade or event mark) and return its marker id.

Contract	Value
Controller	chart
Target scopes	chart
Family	objects
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · chart.addMarker.resourceIds authority extractor · required when constrained resourceKinds · string · chart.addMarker.resourceKinds authority extractor · required when constrained
Revision domains	content
Options index	None

Public SDK signature

(marker: MarkerDefinition) => string

chart.addSmartDrawingwrite · write

Place another set of this tool's drawings and return its placement id.

A Smart Drawing is a DRAWING TOOL, so picking it twice leaves two
independent sets on the chart. Each placement gets its own group, so a set
is selected and erased on its own.

Contract	Value
Controller	chart
Target scopes	chart
Family	objects
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	content
Options index	None

Public SDK signature

(toolId: SmartDrawingToolId, anchor?: SmartDrawingAnchor) => string

chart.addSymbolToWatchlistwrite · write

Add a symbol to a watchlist through the native datafeed watchlist contract.
Defaults to the current chart symbol and the active/default watchlist.

Contract	Value
Controller	chart
Target scopes	chart
Family	watchlists
Implementation	sdk
Permission label	marketdata.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · chart.addSymbolToWatchlist.symbols authority extractor · required when constrained resourceIds · string · chart.addSymbolToWatchlist.resourceIds authority extractor · required when constrained resourceKinds · string · chart.addSymbolToWatchlist.resourceKinds authority extractor · required when constrained chart.addSymbolToWatchlist.allowedSymbols result filter · symbols
Revision domains	watchlist
Options index	None

Public SDK signature

(request?: WatchlistAddSymbolRequest) => Promise<Watchlist>

chart.applyLayoutwrite · write

Restore the chart from a chart-layout object, optionally starting the drawing-state subscription.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartLayouts
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · chart.applyLayout.customizationPaths authority extractor · required when constrained drawingKinds · string · chart.applyLayout.drawingKinds authority extractor · required when constrained symbols · string · chart.applyLayout.symbols authority extractor · required when constrained resourceIds · string · chart.applyLayout.resourceIds authority extractor · required when constrained resourceKinds · string · chart.applyLayout.resourceKinds authority extractor · required when constrained
Revision domains	data, viewport, content, layout, settings, replay, ui
Options index	None

Public SDK signature

(layout: ChartLayout, options?: { startDrawingSubscription?: boolean }) => Promise<void> | void

chart.applyTemplatewrite · write

Apply a chart template to the chart, with optional apply behavior overrides.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartLayouts
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · chart.applyTemplate.customizationPaths authority extractor · optional when constrained drawingKinds · string · chart.applyTemplate.drawingKinds authority extractor · optional when constrained symbols · string · chart.applyTemplate.symbols authority extractor · required when constrained resourceIds · string · chart.applyTemplate.resourceIds authority extractor · required when constrained resourceKinds · string · chart.applyTemplate.resourceKinds authority extractor · required when constrained
Revision domains	data, viewport, content, layout, settings, replay, ui
Options index	None

Public SDK signature

(template: ChartTemplate, options?: ApplyTemplateOptions) => Promise<void> | void

chart.barTimeToEndOfPeriodread · read

Convert a bar start timestamp to the exclusive end of its interval. Tick intervals return the input timestamp.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	None
Options index	None

Public SDK signature

(time: number, interval?: ChartInterval) => number

chart.cancelSelectBarwrite · write

Cancel a pending requestSelectBar call, rejecting its promise.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartSettings
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	ui
Options index	None

Public SDK signature

() => void

chart.clearAlertswrite · write

Remove alerts matching the filter, or all alerts when omitted.

Contract	Value
Controller	chart
Target scopes	chart
Family	objects
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · chart.clearAlerts.symbols authority extractor · required when constrained resourceIds · string · chart.clearAlerts.resourceIds authority extractor · required when constrained resourceKinds · string · chart.clearAlerts.resourceKinds authority extractor · required when constrained
Revision domains	content
Options index	None

Public SDK signature

(filter?: AlertFilter) => void

chart.clearBarswrite · write

Clear the loaded bar series to empty (host then reloads via setSymbol/setInterval or a datafeed push).

Contract	Value
Controller	chart
Target scopes	chart
Family	chartNavigation
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · bars catalog literal · required when constrained
Revision domains	data
Options index	None

Public SDK signature

() => void

chart.clearComparisonswrite · write

Remove every comparison series.

Contract	Value
Controller	chart
Target scopes	chart
Family	objects
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · chart.clearComparisons.resourceIds authority extractor · required when constrained resourceKinds · string · chart.clearComparisons.resourceKinds authority extractor · required when constrained
Revision domains	content
Options index	None

Public SDK signature

() => Promise<void> | void

chart.clearDatafeedMarkswrite · write

Clear rendered datafeed marks/timescale marks without touching host-owned SDK markers.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartNavigation
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · chart.clearDatafeedMarks.resourceConstraintUnavailable authority extractor · required when constrained resourceKinds · string · chart.clearDatafeedMarks.resourceConstraintUnavailable authority extractor · required when constrained
Revision domains	data
Options index	None

Public SDK signature

() => void

chart.clearDrawingGroupwrite · write

Clear only the identified drawing's group membership.

Contract	Value
Controller	chart
Target scopes	chart
Family	drawings
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	drawingKinds · string · chart.clearDrawingGroup.drawingKinds authority extractor · required when constrained resourceIds · string · chart.clearDrawingGroup.resourceIds authority extractor · required when constrained resourceKinds · string · chart.clearDrawingGroup.resourceKinds authority extractor · required when constrained
Revision domains	content
Options index	None

Public SDK signature

(drawingId: string) => Promise<void> | void

chart.clearMarkerswrite · write

Remove markers matching the filter, or all markers when omitted.

Contract	Value
Controller	chart
Target scopes	chart
Family	objects
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · chart.clearMarkers.resourceIds authority extractor · required when constrained resourceKinds · string · chart.clearMarkers.resourceKinds authority extractor · required when constrained
Revision domains	content
Options index	None

Public SDK signature

(filter?: MarkerFilter) => void

chart.clearSelectionwrite · write

Clear the current chart object selection.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartSettings
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · chart.clearSelection.resourceIds authority extractor · required when constrained resourceKinds · string · chart.clearSelection.resourceKinds authority extractor · required when constrained
Revision domains	ui
Options index	None

Public SDK signature

() => Promise<void> | void

chart.clearUndoHistorywrite · write

Drop all undo/redo history (every symbol:interval scope) and start a fresh baseline.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartSettings
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	ui
Options index	None

Public SDK signature

() => void

chart.closePopupswrite · write

Close any open built-in dialogs and popovers.

Contract	Value
Controller	chart
Target scopes	chart
Family	terminalLayout
Implementation	sdk
Permission label	host.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	ui
Options index	None

Public SDK signature

() => void

chart.closeWidgetRailwrite · write

Hide the widget rail.

Contract	Value
Controller	chart
Target scopes	chart
Family	terminalLayout
Implementation	sdk
Permission label	host.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · chart.closeWidgetRail.resourceIds authority extractor · required when constrained resourceKinds · string · chart.closeWidgetRail.resourceKinds authority extractor · required when constrained
Revision domains	ui
Options index	None

Public SDK signature

() => void

chart.copyImageToClipboardwrite · write

Copy a rendered chart bitmap to the browser clipboard. Defaults to PNG for broad clipboard support.

Contract	Value
Controller	chart
Target scopes	chart
Family	terminalLayout
Implementation	sdk
Permission label	host.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · chart.copyImageToClipboard.customizationPaths authority extractor · required when constrained drawingKinds · string · chart.copyImageToClipboard.drawingKinds authority extractor · optional when constrained resourceIds · string · chart.copyImageToClipboard.resourceConstraintUnavailable authority extractor · required when constrained resourceKinds · string · chart.copyImageToClipboard.resourceConstraintUnavailable authority extractor · required when constrained
Revision domains	None
Options index	None

Public SDK signature

(options?: ChartImageExportOptions) => Promise<ChartImageCopyResult>

chart.createDrawingwrite · write

Create a drawing programmatically from a definition and return its drawing id.

Contract	Value
Controller	chart
Target scopes	chart
Family	drawings
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	drawingKinds · string · args[0].type · required when constrained resourceIds · string · chart.createDrawing.resourceIds authority extractor · required when constrained resourceKinds · string · chart.createDrawing.resourceKinds authority extractor · required when constrained
Revision domains	content
Options index	None

Public SDK signature

(drawing: DrawingDefinition) => Promise<string> | string

chart.createIndicatorTemplateread · read

Build a template from the chart's current indicators without persisting it.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · chart.createIndicatorTemplate.resourceIds authority extractor · required when constrained resourceKinds · string · chart.createIndicatorTemplate.resourceKinds authority extractor · required when constrained chart.createIndicatorTemplate.allowedCustomizationDrawing result filter · customizationPaths chart.createIndicatorTemplate.allowedSymbols result filter · symbols chart.createIndicatorTemplate.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

(options?: CreateIndicatorTemplateOptions) => ChartTemplate

chart.createTradingLinewrite · write

Create one chart-owned, JSON-safe order, position, or execution line and return its stable id.
A caller-supplied id is preserved and must be unique; omitted state fields use SDK defaults.

Contract	Value
Controller	chart
Target scopes	chart
Family	orderEntry
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · chart.createTradingLine.resourceIds authority extractor · required when constrained resourceKinds · string · chart.createTradingLine.resourceKinds authority extractor · required when constrained
Revision domains	trading
Options index	None

Public SDK signature

(definition: CreateTradingLineDefinition, options?: CreateTradingLineOptions) => string

chart.dataReadyread · read

Resolve when chart data has completed its current load cycle; callback overload returns whether data was already ready.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	chart.dataReady.allowedSymbols result filter · symbols
Revision domains	None
Options index	None

Public SDK signature

{
    (): Promise<boolean>
    (callback: () => void): boolean
  }

chart.deleteLayoutwrite · write

Delete a saved chart layout from the storage adapter.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartLayouts
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · chart.deleteLayout.customizationPaths authority extractor · required when constrained drawingKinds · string · chart.deleteLayout.drawingKinds authority extractor · required when constrained symbols · string · chart.deleteLayout.symbols authority extractor · required when constrained resourceIds · string · chart.deleteLayout.resourceIds authority extractor · required when constrained resourceKinds · string · chart.deleteLayout.resourceKinds authority extractor · required when constrained
Revision domains	layout
Options index	None

Public SDK signature

(request: DeleteLayoutRequest) => Promise<void>

chart.deleteTemplatewrite · write

Delete a saved template from the storage adapter.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartLayouts
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · chart.deleteTemplate.customizationPaths authority extractor · required when constrained drawingKinds · string · chart.deleteTemplate.drawingKinds authority extractor · required when constrained symbols · string · chart.deleteTemplate.symbols authority extractor · required when constrained resourceIds · string · chart.deleteTemplate.resourceIds authority extractor · required when constrained resourceKinds · string · chart.deleteTemplate.resourceKinds authority extractor · required when constrained
Revision domains	layout
Options index	None

Public SDK signature

(request: DeleteTemplateRequest) => Promise<void>

chart.deleteUserSettingswrite · write

Delete persisted user settings from the storage adapter.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartSettings
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · chart.deleteUserSettings.customizationPaths authority extractor · optional when constrained symbols · string · chart.deleteUserSettings.symbols authority extractor · required when constrained
Revision domains	settings
Options index	None

Public SDK signature

(request?: DeleteUserSettingsRequest) => Promise<void>

chart.dismissSmartDrawingResultwrite · write

Suppress one generated result by its stable id so it does not immediately
reappear on the next recalculation.

Contract	Value
Controller	chart
Target scopes	chart
Family	objects
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	content
Options index	None

Public SDK signature

(toolId: SmartDrawingToolId, resultId: string) => void

chart.duplicateDrawingwrite · write

Clone an existing drawing into a new native drawing instance.

Contract	Value
Controller	chart
Target scopes	chart
Family	drawings
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	drawingKinds · string · chart.duplicateDrawing.drawingKinds authority extractor · required when constrained resourceIds · string · chart.duplicateDrawing.resourceIds authority extractor · required when constrained resourceKinds · string · chart.duplicateDrawing.resourceKinds authority extractor · required when constrained
Revision domains	content
Options index	None

Public SDK signature

(drawingId: string, overrides?: DuplicateDrawingOptions) => Promise<string> | string

chart.duplicateIndicatorwrite · write

Clone an existing indicator into a new native indicator instance, optionally deep-merging overrides.

Contract	Value
Controller	chart
Target scopes	chart
Family	indicators
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · chart.duplicateIndicator.resourceIds authority extractor · required when constrained resourceKinds · string · chart.duplicateIndicator.resourceKinds authority extractor · required when constrained
Revision domains	content
Options index	None

Public SDK signature

(indicatorId: string, overrides?: DuplicateIndicatorOptions) => Promise<string> | string

chart.emitPriceAxisActionwrite · write

Dispatch a price-axis quick action (add alert, add order, buy-stop, sell-limit, draw horizontal
line) at a price onto the chart event bus.

Contract	Value
Controller	chart
Target scopes	chart
Family	terminalLayout
Implementation	sdk
Permission label	host.control
Financial risk classes	None
Decision receipt	None
Input constraints	drawingKinds · string · chart.emitPriceAxisAction.drawingKinds authority extractor · optional when constrained resourceIds · string · chart.emitPriceAxisAction.resourceIds authority extractor · required when constrained resourceKinds · string · chart.emitPriceAxisAction.resourceKinds authority extractor · required when constrained
Revision domains	None
Options index	None

Public SDK signature

(request: PriceAxisActionRequest) => Promise<void> | void

chart.emitTradingIntentwrite · write

Publish a trading intent (e.g. from a shortcut) onto the event bus for host order UIs.

Contract	Value
Controller	chart
Target scopes	chart
Family	terminalLayout
Implementation	sdk
Permission label	host.control
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · chart.emitTradingIntent.symbols authority extractor · required when constrained
Revision domains	None
Options index	None

Public SDK signature

(payload: TradingIntentPayload) => void

chart.endOfPeriodToBarTimeread · read

Convert an interval end timestamp back to its bar start timestamp. Tick intervals return the input timestamp.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	None
Options index	None

Public SDK signature

(time: number, interval?: ChartInterval) => number

chart.ensureHistorywrite · write

Ensure the mounted chart's canonical Store covers an exact time range without changing its viewport.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartNavigation
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · bars catalog literal · required when constrained maxHistoryLookbackMs · finite-number · args[0].endTime - args[0].startTime · required when constrained; absolute magnitude chart.ensureHistory.allowedSymbols result filter · symbols
Revision domains	data
Options index	None

Public SDK signature

(request: EnsureHistoryRequest) => Promise<EnsureHistoryResult>

chart.exportCsvread · read

Export chart, comparison, and indicator columns as CSV using the same schema as exportData().

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · bars catalog literal · required when constrained maxHistoryLookbackMs · finite-number · args[0].timeRange.endTime - args[0].timeRange.startTime · required when constrained; absolute magnitude dataFields · string · args[0].columnIds · required when constrained resourceIds · string · chart.exportCsv.resourceConstraintUnavailable authority extractor · required when constrained resourceKinds · string · chart.exportCsv.resourceConstraintUnavailable authority extractor · required when constrained chart.exportCsv.allowedSymbols result filter · symbols
Revision domains	None
Options index	None

Public SDK signature

(options?: ExportCsvOptions) => Promise<string>

chart.exportDataread · read

Export chart, comparison, and indicator series as a structured ExportedData object.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · bars catalog literal · required when constrained maxHistoryLookbackMs · finite-number · args[0].timeRange.endTime - args[0].timeRange.startTime · required when constrained; absolute magnitude chart.exportData.dataProjection result filter · dataFields, maxRows, maxHistoryLookbackMs chart.exportData.allowedSymbols result filter · symbols chart.exportData.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

(options?: ExportDataOptions) => Promise<ExportedData>

chart.exportTemplateread · read

Serialize a template to a portable string.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · chart.exportTemplate.customizationPaths authority extractor · optional when constrained drawingKinds · string · chart.exportTemplate.drawingKinds authority extractor · optional when constrained symbols · string · chart.exportTemplate.symbols authority extractor · required when constrained resourceIds · string · chart.exportTemplate.resourceIds authority extractor · required when constrained resourceKinds · string · chart.exportTemplate.resourceKinds authority extractor · required when constrained chart.exportTemplate.allowedSymbols result filter · symbols
Revision domains	None
Options index	None

Public SDK signature

(template: ChartTemplate) => string

chart.findBuiltInIndicatorsread · read

Search and filter cloned native built-in indicator definitions without host-side catalog scans.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	resourceKinds · string · chart.findBuiltInIndicators.resourceKinds authority extractor · required when constrained chart.findBuiltInIndicators.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

(filter?: BuiltInIndicatorFilter) => BuiltInIndicatorDefinition[]

chart.formatPriceread · read

Format a price using the chart-owned formatter.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	projection
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	chart.formatPrice.allowedSymbols result filter · symbols
Revision domains	None
Options index	None

Public SDK signature

(price: number) => string

chart.getAlertsread · read

Return current alerts, optionally filtered.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · chart.getAlerts.symbols authority extractor · optional when constrained resourceIds · string · chart.getAlerts.resourceIds authority extractor · required when constrained resourceKinds · string · chart.getAlerts.resourceKinds authority extractor · required when constrained chart.getAlerts.allowedSymbols result filter · symbols chart.getAlerts.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

(filter?: AlertFilter) => AlertDefinition[]

chart.getBuiltInIndicatorread · read

Return one cloned native built-in indicator definition by exact id.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	resourceKinds · string · chart.getBuiltInIndicator.resourceKinds authority extractor · required when constrained chart.getBuiltInIndicator.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

(indicatorId: string) => BuiltInIndicatorDefinition | undefined

chart.getChartTyperead · read

Return the currently active chart type.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	None
Options index	None

Public SDK signature

() => ChartType

chart.getComparisonBarsread · read

Return the loaded bars of one comparison series by id.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · bars catalog literal · required when constrained resourceIds · string · chart.getComparisonBars.resourceIds authority extractor · required when constrained resourceKinds · string · chart.getComparisonBars.resourceKinds authority extractor · required when constrained chart.getComparisonBars.dataProjection result filter · dataFields, maxRows, maxHistoryLookbackMs chart.getComparisonBars.allowedSymbols result filter · symbols
Revision domains	None
Options index	None

Public SDK signature

(comparisonId: string) => Bar[]

chart.getComparisonsread · read

Return the active comparison series.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	chart.getComparisons.allowedSymbols result filter · symbols chart.getComparisons.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

() => ComparisonSeries[]

chart.getCrosshairread · read

Return the current crosshair state, or undefined when no crosshair is shown.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	chart.getCrosshair.allowedSymbols result filter · symbols
Revision domains	None
Options index	None

Public SDK signature

() => CrosshairState | undefined

chart.getDisplaySettingsread · read

Return the current chart display settings.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	chart.getDisplaySettings.allowedCustomizationDrawing result filter · customizationPaths
Revision domains	None
Options index	None

Public SDK signature

() => ChartDisplaySettings

chart.getDrawingread · read

Return a cloned drawing snapshot by id without requiring hosts to scan listDrawings().

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · chart.getDrawing.resourceIds authority extractor · required when constrained resourceKinds · string · chart.getDrawing.resourceKinds authority extractor · required when constrained chart.getDrawing.allowedCustomizationDrawing result filter · drawingKinds chart.getDrawing.allowedSymbols result filter · symbols chart.getDrawing.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

(drawingId: string) => DrawingDefinition | undefined

chart.getDrawingsread · read

Return the chart's whole drawing state as a snapshot.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	chart.getDrawings.allowedCustomizationDrawing result filter · drawingKinds chart.getDrawings.allowedSymbols result filter · symbols chart.getDrawings.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

() => DrawingSnapshot

chart.getDrawingSharingStateread · read

Return the collaborative drawing-sharing state (mode, permissions, conflict status).

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	chart.getDrawingSharingState.allowedCustomizationDrawing result filter · drawingKinds chart.getDrawingSharingState.allowedSymbols result filter · symbols chart.getDrawingSharingState.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

() => DrawingSharingState

chart.getFavoriteChartTypesread · read

Return the chart types currently pinned as toolbar favorites.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	None
Options index	None

Public SDK signature

() => ChartType[]

chart.getFavoriteDrawingToolsread · read

Return the drawing-tool ids currently pinned as toolbar favorites.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	chart.getFavoriteDrawingTools.allowedCustomizationDrawing result filter · customizationPaths, drawingKinds chart.getFavoriteDrawingTools.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

() => string[]

chart.getFavoriteIndicatorsread · read

Return the indicator ids currently pinned as favorites.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	chart.getFavoriteIndicators.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

() => string[]

chart.getFavoriteIntervalsread · read

Return the interval ids currently pinned as toolbar favorites.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	None
Options index	None

Public SDK signature

() => string[]

chart.getFootprintread · read

Return the active footprint chart options, or null when footprint mode is off.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	chart.getFootprint.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

() => FootprintChartOptions | null

chart.getHoverObjectread · read

The object currently under the pointer (hover), for host hit-testing e.g. an eraser tool.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	chart.getHoverObject.allowedCustomizationDrawing result filter · drawingKinds chart.getHoverObject.allowedSymbols result filter · symbols chart.getHoverObject.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

() => ChartObjectNode | undefined

chart.getIndicatorread · read

Return a cloned indicator snapshot by id without requiring hosts to scan getIndicators().

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · chart.getIndicator.resourceIds authority extractor · required when constrained resourceKinds · string · chart.getIndicator.resourceKinds authority extractor · required when constrained chart.getIndicator.allowedSymbols result filter · symbols chart.getIndicator.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

(indicatorId: string) => IndicatorDefinition | undefined

chart.getIndicatorsread · read

Return the active indicator definitions, optionally filtered.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · chart.getIndicators.resourceIds authority extractor · required when constrained resourceKinds · string · chart.getIndicators.resourceKinds authority extractor · required when constrained chart.getIndicators.allowedSymbols result filter · symbols chart.getIndicators.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

(filter?: IndicatorFilter) => IndicatorDefinition[]

chart.getIntervalread · read

Returns the currently active bar interval.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	None
Options index	None

Public SDK signature

() => ChartInterval

chart.getLayoutread · read

Return the chart's current state as a serializable chart layout, optionally under a given
chart-layout id and with drawings included.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · chart.getLayout.resourceIds authority extractor · required when constrained resourceKinds · string · chart.getLayout.resourceKinds authority extractor · required when constrained chart.getLayout.allowedCustomizationDrawing result filter · customizationPaths, drawingKinds chart.getLayout.allowedSymbols result filter · symbols chart.getLayout.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

(layoutId?: ChartLayoutId, options?: { includeDrawings?: boolean }) => ChartLayout

chart.getLoadedBarsread · read

Return the currently loaded bar series for the chart's main symbol.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · bars catalog literal · required when constrained chart.getLoadedBars.dataProjection result filter · dataFields, maxRows, maxHistoryLookbackMs chart.getLoadedBars.allowedSymbols result filter · symbols
Revision domains	None
Options index	None

Public SDK signature

() => Bar[]

chart.getMagnetModeread · read

Return the current snap (magnet) mode for drawing placement and drags.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	chart.getMagnetMode.allowedCustomizationDrawing result filter · customizationPaths
Revision domains	None
Options index	None

Public SDK signature

() => MagnetMode

chart.getMarkersread · read

Return current markers, optionally filtered.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · chart.getMarkers.resourceIds authority extractor · required when constrained resourceKinds · string · chart.getMarkers.resourceKinds authority extractor · required when constrained chart.getMarkers.allowedSymbols result filter · symbols chart.getMarkers.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

(filter?: MarkerFilter) => MarkerDefinition[]

chart.getObjectread · read

Return one chart object node by id, or undefined when no such object exists.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · chart.getObject.resourceIds authority extractor · required when constrained resourceKinds · string · chart.getObject.resourceKinds authority extractor · required when constrained chart.getObject.allowedCustomizationDrawing result filter · drawingKinds chart.getObject.allowedSymbols result filter · symbols chart.getObject.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

(objectId: string) => ChartObjectNode | undefined

chart.getOrderFlowHeatmapread · read

Return the active order-flow liquidity heatmap options, or null when the heatmap is off.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	chart.getOrderFlowHeatmap.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

() => OrderFlowHeatmapOptions | null

chart.getPaneLayoutread · read

Return the current panes in order with their heights and states.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	chart.getPaneLayout.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

() => PaneLayoutItem[]

chart.getPaneVisiblePriceRangeread · read

Return one pane-and-scale visible value range, or null when that pane/scale is unavailable.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · chart.getPaneVisiblePriceRange.resourceIds authority extractor · required when constrained resourceKinds · string · chart.getPaneVisiblePriceRange.resourceKinds authority extractor · required when constrained
Revision domains	None
Options index	None

Public SDK signature

(paneId: string, scaleId?: string) => PriceRange | null

chart.getPriceScaleread · read

Return the current price-scale settings.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	chart.getPriceScale.allowedSymbols result filter · symbols chart.getPriceScale.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

() => PriceScaleSettings

chart.getPriceScaleSourcesread · read

List the chart sources whose values, placement, and visibility are owned by a scale id.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · chart.getPriceScaleSources.resourceIds authority extractor · required when constrained resourceKinds · string · chart.getPriceScaleSources.resourceKinds authority extractor · required when constrained chart.getPriceScaleSources.allowedSymbols result filter · symbols chart.getPriceScaleSources.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

(scaleId: string, paneId?: string) => PriceScaleSourceReference[]

chart.getPriceToBarRatioread · read

Return the fixed price-to-bar ratio, or null when none is set.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	chart.getPriceToBarRatio.allowedSymbols result filter · symbols
Revision domains	None
Options index	None

Public SDK signature

() => number | null

chart.getSelectedDrawingToolread · read

The currently armed interactive drawing tool, or null.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	chart.getSelectedDrawingTool.allowedCustomizationDrawing result filter · drawingKinds chart.getSelectedDrawingTool.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

() => string | null

chart.getSelectionread · read

Return the current chart object selection.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	chart.getSelection.allowedCustomizationDrawing result filter · drawingKinds chart.getSelection.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

() => ChartObjectSelection

chart.getSmartDrawingStateread · read

Current state of one Smart Drawing tool, including its results.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	None
Options index	None

Public SDK signature

(toolId: SmartDrawingToolId) => SmartDrawingToolState

chart.getStateread · read

Returns a serializable snapshot of the chart's current state (symbol, interval, chart type,
drawings, indicators, settings, and viewport).

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	chart.getState.allowedCustomizationDrawing result filter · customizationPaths, drawingKinds chart.getState.allowedSymbols result filter · symbols chart.getState.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

() => ChartState

chart.getStorageCapabilitiesread · read

Return which storage operations the configured adapter supports.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	None
Options index	None

Public SDK signature

() => ChartStorageCapabilities

chart.getSymbolread · read

Returns the currently active resolved symbol.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	chart.getSymbol.allowedSymbols result filter · symbols
Revision domains	None
Options index	None

Public SDK signature

() => SdkSymbolInfo

chart.getTradingLineread · read

Return a cloned canonical definition by stable id, or undefined when it does not exist.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · chart.getTradingLine.resourceIds authority extractor · required when constrained resourceKinds · string · chart.getTradingLine.resourceKinds authority extractor · required when constrained chart.getTradingLine.allowedSymbols result filter · symbols chart.getTradingLine.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

(tradingLineId: string) => TradingLineDefinition | undefined

chart.getUndoRedoStateread · read

Return the current undo/redo availability for the chart's content history.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	None
Options index	None

Public SDK signature

() => UndoRedoState

chart.getUserSettingsread · read

Return the in-memory user-settings state.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	chart.getUserSettings.allowedCustomizationDrawing result filter · customizationPaths chart.getUserSettings.allowedSymbols result filter · symbols
Revision domains	None
Options index	None

Public SDK signature

() => UserSettingsState

chart.getVisibleBarRangeread · read

Return the visible range in bar indices (with real data bounds and a price summary), or
undefined before the chart has one.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	chart.getVisibleBarRange.allowedSymbols result filter · symbols
Revision domains	None
Options index	None

Public SDK signature

() => VisibleBarRange | undefined

chart.getVisibleRangeread · read

Return the visible time range, or undefined before the chart has one.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	chart.getVisibleRange.allowedSymbols result filter · symbols
Revision domains	None
Options index	None

Public SDK signature

() => VisibleTimeRange | undefined

chart.getWidgetRailStateread · read

Return the state of the side widget rail (visibility, active panel, width, collapsed).

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	chart.getWidgetRailState.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

() => WidgetRailState

chart.groupDrawingswrite · write

Assign the given drawings to a named group.

Contract	Value
Controller	chart
Target scopes	chart
Family	drawings
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	drawingKinds · string · chart.groupDrawings.drawingKinds authority extractor · required when constrained resourceIds · string · chart.groupDrawings.resourceIds authority extractor · required when constrained resourceKinds · string · chart.groupDrawings.resourceKinds authority extractor · required when constrained
Revision domains	content
Options index	None

Public SDK signature

(groupId: string, drawingIds: string[]) => Promise<void> | void

chart.importTemplateread · read

Parse a serialized template string back into a ChartTemplate.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	chart.importTemplate.allowedCustomizationDrawing result filter · customizationPaths, drawingKinds chart.importTemplate.allowedSymbols result filter · symbols chart.importTemplate.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

(serialized: string) => ChartTemplate

chart.isDragExportEnabledread · read

Return whether drag export is currently enabled.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	None
Options index	None

Public SDK signature

() => boolean

chart.isPriceToBarRatioLockedread · read

Return whether the price-to-bar ratio is currently locked.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	None
Options index	None

Public SDK signature

() => boolean

chart.isSelectBarRequestedread · read

Return whether an interactive bar selection is currently pending.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	None
Options index	None

Public SDK signature

() => boolean

chart.keepSmartDrawingResultwrite · write

Convert one generated result into a normal editable, persistent drawing and
return its drawing id. The managed copy is suppressed so the kept drawing is
not duplicated.

Contract	Value
Controller	chart
Target scopes	chart
Family	objects
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	drawingKinds · string · chart.keepSmartDrawingResult.drawingKinds authority extractor · required when constrained
Revision domains	content
Options index	None

Public SDK signature

(toolId: SmartDrawingToolId, resultId: string) => string

chart.listBuiltInIndicatorCategoriesread · read

Return sorted native built-in indicator categories from catalog metadata.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	chart.listBuiltInIndicatorCategories.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

() => string[]

chart.listBuiltInIndicatorsread · read

Return the catalog of built-in indicator definitions.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	chart.listBuiltInIndicators.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

() => BuiltInIndicatorDefinition[]

chart.listChartTypesread · read

Return every chart type this chart can render.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	None
Options index	None

Public SDK signature

() => ChartType[]

chart.listDrawingsread · read

Return every drawing currently on the chart.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	chart.listDrawings.allowedCustomizationDrawing result filter · drawingKinds chart.listDrawings.allowedSymbols result filter · symbols chart.listDrawings.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

() => DrawingDefinition[]

chart.listDrawingToolsread · read

Return native drawing-tool definitions with anchor and style descriptors. Optional query matches id/label words, group and toolId are exact filters; omit to return the full catalog.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	chart.listDrawingTools.allowedCustomizationDrawing result filter · drawingKinds chart.listDrawingTools.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

(filter?: { query?: string; group?: string; toolId?: string }) => DrawingToolDefinition[]

chart.listLayoutsread · read

List saved chart-layout summaries from the storage adapter.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · chart.listLayouts.symbols authority extractor · required when constrained resourceIds · string · chart.listLayouts.resourceIds authority extractor · required when constrained resourceKinds · string · chart.listLayouts.resourceKinds authority extractor · required when constrained chart.listLayouts.allowedSymbols result filter · symbols chart.listLayouts.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

(request?: ListLayoutsRequest) => Promise<ChartLayoutSummary[]>

chart.listObjectsread · read

Return the unified chart object tree (drawings, indicators, and provider-contributed entities).

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	chart.listObjects.allowedCustomizationDrawing result filter · drawingKinds chart.listObjects.allowedSymbols result filter · symbols chart.listObjects.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

() => ChartObjectNode[]

chart.listPriceScaleSlotsread · read

Return the current host-defined price-scale slot definitions.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	chart.listPriceScaleSlots.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

() => PriceScaleSlotDefinition[]

chart.listSmartDrawingPlacementsread · read

Placement ids currently on the chart for one tool, oldest first.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	None
Options index	None

Public SDK signature

(toolId: SmartDrawingToolId) => readonly string[]

chart.listSmartDrawingToolsread · read

Smart Drawings. Chart-computed levels, breaks and patterns that run in the
chart worker and project locked, chart-managed overlays.

These are not indicators and not placement tools: toggling one never arms
the pointer, and the generated overlays stay out of drawing storage,
sharing, undo, and user drawing counts. keepSmartDrawingResult is the one
path that turns a result into a normal, editable, persistent drawing.

Execution is worker-only. When the chart worker is disabled or unavailable
the tool reports unavailable — nothing falls back to the main thread.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	None
Options index	None

Public SDK signature

() => SmartDrawingToolDefinition[]

chart.listTemplatesread · read

List saved templates from the storage adapter.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · chart.listTemplates.symbols authority extractor · required when constrained resourceIds · string · chart.listTemplates.resourceIds authority extractor · required when constrained resourceKinds · string · chart.listTemplates.resourceKinds authority extractor · required when constrained chart.listTemplates.allowedCustomizationDrawing result filter · customizationPaths, drawingKinds chart.listTemplates.allowedSymbols result filter · symbols chart.listTemplates.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

(request?: ListTemplatesRequest) => Promise<ChartTemplate[]>

chart.listTimeFramesread · read

Return the available time-frame presets (range plus resolution definitions).

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	None
Options index	None

Public SDK signature

() => TimeFrameDefinition[]

chart.listTradingLinesread · read

List cloned canonical definitions, optionally filtered by the exact order/position/execution kind.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	resourceKinds · string · chart.listTradingLines.resourceKinds authority extractor · required when constrained chart.listTradingLines.allowedSymbols result filter · symbols chart.listTradingLines.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

(filter?: TradingLineFilter) => TradingLineDefinition[]

chart.loadDrawingswrite · write

Load drawing state from the storage adapter and apply it, resolving with the state or null
when none exists.

Contract	Value
Controller	chart
Target scopes	chart
Family	drawings
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	drawingKinds · string · chart.loadDrawings.drawingKinds authority extractor · required when constrained symbols · string · chart.loadDrawings.symbols authority extractor · required when constrained resourceIds · string · chart.loadDrawings.resourceConstraintUnavailable authority extractor · required when constrained resourceKinds · string · chart.loadDrawings.resourceConstraintUnavailable authority extractor · required when constrained chart.loadDrawings.allowedCustomizationDrawing result filter · drawingKinds chart.loadDrawings.allowedSymbols result filter · symbols
Revision domains	content
Options index	None

Public SDK signature

(request?: LoadDrawingsRequest) => Promise<DrawingState | null>

chart.loadLayoutwrite · write

Load a saved chart layout from the storage adapter and apply it, resolving with the chart
layout or null when not found.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartLayouts
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · chart.loadLayout.customizationPaths authority extractor · optional when constrained drawingKinds · string · chart.loadLayout.drawingKinds authority extractor · optional when constrained symbols · string · chart.loadLayout.symbols authority extractor · required when constrained resourceIds · string · chart.loadLayout.resourceConstraintUnavailable authority extractor · required when constrained resourceKinds · string · chart.loadLayout.resourceConstraintUnavailable authority extractor · required when constrained chart.loadLayout.allowedCustomizationDrawing result filter · customizationPaths, drawingKinds chart.loadLayout.allowedSymbols result filter · symbols
Revision domains	data, viewport, content, layout, settings, replay, ui
Options index	None

Public SDK signature

(request: LoadLayoutRequest) => Promise<ChartLayout | null>

chart.loadTemplateread · read

Load a saved template from the storage adapter, resolving with the template or null when not
found.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · chart.loadTemplate.symbols authority extractor · required when constrained resourceIds · string · chart.loadTemplate.resourceIds authority extractor · required when constrained resourceKinds · string · chart.loadTemplate.resourceKinds authority extractor · required when constrained chart.loadTemplate.allowedCustomizationDrawing result filter · customizationPaths, drawingKinds chart.loadTemplate.allowedSymbols result filter · symbols chart.loadTemplate.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

(request: LoadTemplateRequest) => Promise<ChartTemplate | null>

chart.loadUserSettingswrite · write

Load user settings from the storage adapter and apply them, resolving with the state or null
when none exist.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartSettings
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · chart.loadUserSettings.customizationPaths authority extractor · required when constrained symbols · string · chart.loadUserSettings.symbols authority extractor · required when constrained chart.loadUserSettings.allowedCustomizationDrawing result filter · customizationPaths chart.loadUserSettings.allowedSymbols result filter · symbols
Revision domains	settings
Options index	None

Public SDK signature

(request?: LoadUserSettingsRequest) => Promise<UserSettingsState | null>

chart.maximizePanewrite · write

Expand one pane to fill the chart and return the resulting layout.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartLayouts
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · chart.maximizePane.resourceIds authority extractor · required when constrained resourceKinds · string · chart.maximizePane.resourceKinds authority extractor · required when constrained
Revision domains	layout
Options index	None

Public SDK signature

(paneId: string) => PaneLayoutItem[]

chart.minimizePanewrite · write

Collapse one pane to its minimized state and return the resulting layout.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartLayouts
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · chart.minimizePane.resourceIds authority extractor · required when constrained resourceKinds · string · chart.minimizePane.resourceKinds authority extractor · required when constrained
Revision domains	layout
Options index	None

Public SDK signature

(paneId: string) => PaneLayoutItem[]

chart.moveObjectwrite · write

Re-parent or reposition a chart object relative to a target object, with optional placement.

Contract	Value
Controller	chart
Target scopes	chart
Family	objects
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	drawingKinds · string · chart.moveObject.drawingKinds authority extractor · optional when constrained resourceIds · string · chart.moveObject.resourceIds authority extractor · required when constrained resourceKinds · string · chart.moveObject.resourceKinds authority extractor · required when constrained
Revision domains	content
Options index	None

Public SDK signature

(objectId: string, targetObjectId: string, placement?: ChartObjectMovePlacement) => Promise<void> | void

chart.openGoToDatewrite · write

Open the built-in go-to-date dialog.

Contract	Value
Controller	chart
Target scopes	chart
Family	terminalLayout
Implementation	sdk
Permission label	host.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	ui
Options index	None

Public SDK signature

() => void

chart.openIndicatorsDialogwrite · write

Open the built-in indicators picker (no-op when the surface renders no picker).

Contract	Value
Controller	chart
Target scopes	chart
Family	terminalLayout
Implementation	sdk
Permission label	host.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	ui
Options index	None

Public SDK signature

() => void

chart.openIntervalDialogwrite · write

Open the built-in interval selector and optionally seed the custom interval text.

Contract	Value
Controller	chart
Target scopes	chart
Family	terminalLayout
Implementation	sdk
Permission label	host.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	ui
Options index	None

Public SDK signature

(initialText?: string) => void

chart.openSettingsDialogwrite · write

Open the built-in chart settings dialog (modal or bottom sheet per features.chartControls.settingsPresentation).

Contract	Value
Controller	chart
Target scopes	chart
Family	terminalLayout
Implementation	sdk
Permission label	host.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	ui
Options index	None

Public SDK signature

() => void

chart.openStorageDialogwrite · write

Open the built-in storage (layout/template) dialog in the given mode.

Contract	Value
Controller	chart
Target scopes	chart
Family	terminalLayout
Implementation	sdk
Permission label	host.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	ui
Options index	None

Public SDK signature

(mode: 'save' | 'save-as' | 'load') => void

chart.openSymbolSearchwrite · write

Open the built-in symbol-search dialog, optionally pre-filled with a query.

Contract	Value
Controller	chart
Target scopes	chart
Family	terminalLayout
Implementation	sdk
Permission label	host.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	ui
Options index	None

Public SDK signature

(initialQuery?: string) => void

chart.openWidgetRailPanelwrite · write

Open the widget rail on the given panel (e.g. watchlist, details, order-ticket),
optionally patching width or collapsed state.

Contract	Value
Controller	chart
Target scopes	chart
Family	terminalLayout
Implementation	sdk
Permission label	host.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · chart.openWidgetRailPanel.resourceIds authority extractor · required when constrained resourceKinds · string · chart.openWidgetRailPanel.resourceKinds authority extractor · required when constrained
Revision domains	ui
Options index	None

Public SDK signature

(panelId: WidgetRailPanelId, options?: WidgetRailOpenOptions) => void

chart.panwrite · write

Pan by a fraction of the viewport using native drag scrolling and automatic history paging. No bar-index lookup is required.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartNavigation
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	viewport
Options index	None

Public SDK signature

(direction: 'left' | 'right', viewportFraction?: number) => void

chart.redowrite · write

Re-apply the most recently undone content change. Resolves true when a change was re-applied.

Contract	Value
Controller	chart
Target scopes	chart
Family	objects
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · chart.redo.customizationPaths authority extractor · required when constrained drawingKinds · string · chart.redo.drawingKinds authority extractor · required when constrained resourceIds · string · chart.redo.resourceConstraintUnavailable authority extractor · required when constrained resourceKinds · string · chart.redo.resourceConstraintUnavailable authority extractor · required when constrained
Revision domains	content, ui
Options index	None

Public SDK signature

() => Promise<boolean>

chart.refreshDatafeedMarkswrite · write

Refetch MarketDataFeed.getMarks and getTimescaleMarks for the loaded visible history span.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartNavigation
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · chart.refreshDatafeedMarks.resourceConstraintUnavailable authority extractor · required when constrained resourceKinds · string · chart.refreshDatafeedMarks.resourceConstraintUnavailable authority extractor · required when constrained
Revision domains	data
Options index	None

Public SDK signature

() => Promise<void> | void

chart.refreshDrawingSharingPermissionswrite · write

Refetch the caller's drawing-sharing permissions and resolve with the result.

Contract	Value
Controller	chart
Target scopes	chart
Family	drawings
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	content
Options index	None

Public SDK signature

() => Promise<DrawingSharingPermissions>

chart.refreshSmartDrawingwrite · write

Force a recomputation of one tool from the current bars.

Contract	Value
Controller	chart
Target scopes	chart
Family	objects
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	content
Options index	None

Public SDK signature

(toolId: SmartDrawingToolId) => void

chart.reloadComparisonwrite · write

Refetch one comparison series' data from the datafeed.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartNavigation
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · bars catalog literal · required when constrained resourceIds · string · chart.reloadComparison.resourceIds authority extractor · required when constrained resourceKinds · string · chart.reloadComparison.resourceKinds authority extractor · required when constrained
Revision domains	data
Options index	None

Public SDK signature

(comparisonId: string) => Promise<void>

chart.reloadDrawingswrite · write

Reload drawing state from storage for the current chart, resolving with the state or null.

Contract	Value
Controller	chart
Target scopes	chart
Family	drawings
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	drawingKinds · string · chart.reloadDrawings.drawingKinds authority extractor · required when constrained resourceIds · string · chart.reloadDrawings.resourceConstraintUnavailable authority extractor · required when constrained resourceKinds · string · chart.reloadDrawings.resourceConstraintUnavailable authority extractor · required when constrained chart.reloadDrawings.allowedCustomizationDrawing result filter · drawingKinds chart.reloadDrawings.allowedSymbols result filter · symbols
Revision domains	content
Options index	None

Public SDK signature

() => Promise<DrawingState | null>

chart.removeAlertwrite · write

Remove one alert by id.

Contract	Value
Controller	chart
Target scopes	chart
Family	objects
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · chart.removeAlert.resourceIds authority extractor · required when constrained resourceKinds · string · chart.removeAlert.resourceKinds authority extractor · required when constrained
Revision domains	content
Options index	None

Public SDK signature

(alertId: string) => void

chart.removeComparisonwrite · write

Remove one comparison series by id.

Contract	Value
Controller	chart
Target scopes	chart
Family	objects
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · chart.removeComparison.resourceIds authority extractor · required when constrained resourceKinds · string · chart.removeComparison.resourceKinds authority extractor · required when constrained
Revision domains	content
Options index	None

Public SDK signature

(comparisonId: string) => Promise<void> | void

chart.removeDrawingwrite · write

Remove one drawing by id.

Contract	Value
Controller	chart
Target scopes	chart
Family	drawings
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	drawingKinds · string · chart.removeDrawing.drawingKinds authority extractor · required when constrained resourceIds · string · chart.removeDrawing.resourceIds authority extractor · required when constrained resourceKinds · string · chart.removeDrawing.resourceKinds authority extractor · required when constrained
Revision domains	content
Options index	None

Public SDK signature

(drawingId: string) => Promise<void> | void

chart.removeDrawingswrite · write

Bulk-remove drawings matching a filter (by group/type/pane). With no filter, removes all.

Contract	Value
Controller	chart
Target scopes	chart
Family	drawings
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	drawingKinds · string · chart.removeDrawings.drawingKinds authority extractor · optional when constrained resourceIds · string · chart.removeDrawings.resourceIds authority extractor · required when constrained resourceKinds · string · chart.removeDrawings.resourceKinds authority extractor · required when constrained
Revision domains	content
Options index	None

Public SDK signature

(filter?: DrawingFilter) => Promise<void> | void

chart.removeIndicatorwrite · write

Remove one indicator by id.

Contract	Value
Controller	chart
Target scopes	chart
Family	indicators
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · chart.removeIndicator.resourceIds authority extractor · required when constrained resourceKinds · string · chart.removeIndicator.resourceKinds authority extractor · required when constrained
Revision domains	content
Options index	None

Public SDK signature

(indicatorId: string) => Promise<void> | void

chart.removeIndicatorswrite · write

Bulk-remove indicators matching a filter (all when omitted) and return the removed ids.

Contract	Value
Controller	chart
Target scopes	chart
Family	indicators
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · chart.removeIndicators.resourceIds authority extractor · required when constrained resourceKinds · string · chart.removeIndicators.resourceKinds authority extractor · required when constrained
Revision domains	content
Options index	None

Public SDK signature

(filter?: IndicatorFilter) => string[]

chart.removeMarkerwrite · write

Remove one marker by id.

Contract	Value
Controller	chart
Target scopes	chart
Family	objects
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · chart.removeMarker.resourceIds authority extractor · required when constrained resourceKinds · string · chart.removeMarker.resourceKinds authority extractor · required when constrained
Revision domains	content
Options index	None

Public SDK signature

(markerId: string) => void

chart.removeObjectwrite · write

Remove a chart object by id.

Contract	Value
Controller	chart
Target scopes	chart
Family	objects
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	drawingKinds · string · chart.removeObject.drawingKinds authority extractor · optional when constrained resourceIds · string · chart.removeObject.resourceIds authority extractor · required when constrained resourceKinds · string · chart.removeObject.resourceKinds authority extractor · required when constrained
Revision domains	content
Options index	None

Public SDK signature

(objectId: string) => Promise<void> | void

chart.removePriceScaleSlotwrite · write

Remove one price-scale slot by id and return the remaining slots.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartNavigation
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · chart.removePriceScaleSlot.resourceIds authority extractor · required when constrained resourceKinds · string · chart.removePriceScaleSlot.resourceKinds authority extractor · required when constrained
Revision domains	viewport
Options index	None

Public SDK signature

(slotId: string) => PriceScaleSlotDefinition[]

chart.removeSmartDrawingwrite · write

Erase one placed set by its placement id.

Contract	Value
Controller	chart
Target scopes	chart
Family	objects
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	content
Options index	None

Public SDK signature

(placementId: string) => void

chart.removeTradingLinewrite · write

Remove one line and its overlay by stable id; missing ids fail.

Contract	Value
Controller	chart
Target scopes	chart
Family	orderEntry
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · chart.removeTradingLine.resourceIds authority extractor · required when constrained resourceKinds · string · chart.removeTradingLine.resourceKinds authority extractor · required when constrained
Revision domains	trading
Options index	None

Public SDK signature

(tradingLineId: string) => void

chart.removeUserSettingwrite · write

Remove one user-settings key.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartSettings
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · chart.removeUserSetting.customizationPaths authority extractor · required when constrained
Revision domains	settings
Options index	None

Public SDK signature

(key: string) => Promise<void> | void

chart.reorderObjectwrite · write

Move a chart object one step or to the extreme of its z-order in the given direction.

Contract	Value
Controller	chart
Target scopes	chart
Family	objects
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	drawingKinds · string · chart.reorderObject.drawingKinds authority extractor · optional when constrained resourceIds · string · chart.reorderObject.resourceIds authority extractor · required when constrained resourceKinds · string · chart.reorderObject.resourceKinds authority extractor · required when constrained
Revision domains	content
Options index	None

Public SDK signature

(objectId: string, direction: ChartObjectReorderDirection) => Promise<void> | void

chart.requestSelectBarwrite · write

Enter interactive bar-selection mode and resolve with the timestamp of the next bar the user
clicks; rejects if a selection is already pending or is cancelled.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartSettings
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	chart.requestSelectBar.allowedSymbols result filter · symbols
Revision domains	ui
Options index	None

Public SDK signature

() => Promise<number>

chart.resetCachewrite · write

Clear feed-side caches, drop SDK-held bar memory, and ask the mounted chart engine to reload data.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartNavigation
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	data
Options index	None

Public SDK signature

(options?: CacheResetOptions) => Promise<void>

chart.resetPanePriceScalewrite · write

Reset one explicit pane's price scale to its native auto-fitted state.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartNavigation
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · chart.resetPanePriceScale.resourceIds authority extractor · required when constrained resourceKinds · string · chart.resetPanePriceScale.resourceKinds authority extractor · required when constrained
Revision domains	viewport
Options index	None

Public SDK signature

(paneId: string) => Promise<void> | void

chart.resetPriceScalewrite · write

Reset the price scale back to its default auto-scaled state.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartNavigation
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · chart.resetPriceScale.resourceIds authority extractor · required when constrained resourceKinds · string · chart.resetPriceScale.resourceKinds authority extractor · required when constrained
Revision domains	viewport
Options index	None

Public SDK signature

() => Promise<void> | void

chart.resizewrite · write

Re-measures the mount container and relays out the chart after a host-driven size change.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartLayouts
Implementation	sdk
Permission label	host.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	layout
Options index	None

Public SDK signature

() => void

chart.resolveDrawingSharingConflictwrite · write

Resolve a drawing-sharing conflict by reloading the server copy (reload-server) or keeping the
local copy (keep-mine).

Contract	Value
Controller	chart
Target scopes	chart
Family	drawings
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	drawingKinds · string · chart.resolveDrawingSharingConflict.drawingKinds authority extractor · required when constrained resourceIds · string · chart.resolveDrawingSharingConflict.resourceConstraintUnavailable authority extractor · required when constrained resourceKinds · string · chart.resolveDrawingSharingConflict.resourceConstraintUnavailable authority extractor · required when constrained
Revision domains	content
Options index	None

Public SDK signature

(resolution: 'reload-server' | 'keep-mine') => Promise<void>

chart.restorePanewrite · write

Restore a maximized or minimized pane to its normal size and return the resulting layout.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartLayouts
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · chart.restorePane.resourceIds authority extractor · required when constrained resourceKinds · string · chart.restorePane.resourceKinds authority extractor · required when constrained
Revision domains	layout
Options index	None

Public SDK signature

(paneId: string) => PaneLayoutItem[]

chart.saveDrawingswrite · write

Persist the current (or supplied) drawing state through the storage adapter, resolving with the
save result when the adapter reports one.

Contract	Value
Controller	chart
Target scopes	chart
Family	drawings
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	drawingKinds · string · chart.saveDrawings.drawingKinds authority extractor · optional when constrained symbols · string · chart.saveDrawings.symbols authority extractor · required when constrained resourceIds · string · chart.saveDrawings.resourceIds authority extractor · required when constrained resourceKinds · string · chart.saveDrawings.resourceKinds authority extractor · required when constrained
Revision domains	content
Options index	None

Public SDK signature

(request?: Omit<SaveDrawingsRequest, 'drawings'> & { drawings?: DrawingState }) => Promise<SaveDrawingsResult | void>

chart.saveLayoutwrite · write

Save the current (or a supplied) chart layout through the storage adapter and resolve with the
save result.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartLayouts
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · chart.saveLayout.customizationPaths authority extractor · optional when constrained drawingKinds · string · chart.saveLayout.drawingKinds authority extractor · optional when constrained symbols · string · chart.saveLayout.symbols authority extractor · required when constrained resourceIds · string · chart.saveLayout.resourceIds authority extractor · required when constrained resourceKinds · string · chart.saveLayout.resourceKinds authority extractor · required when constrained
Revision domains	layout
Options index	None

Public SDK signature

(request?: Omit<SaveLayoutRequest, 'layout'> & { layout?: ChartLayout }) => Promise<SaveLayoutResult>

chart.saveTemplatewrite · write

Persist a chart template through the storage adapter.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartLayouts
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · chart.saveTemplate.customizationPaths authority extractor · optional when constrained drawingKinds · string · chart.saveTemplate.drawingKinds authority extractor · optional when constrained symbols · string · chart.saveTemplate.symbols authority extractor · required when constrained resourceIds · string · chart.saveTemplate.resourceIds authority extractor · required when constrained resourceKinds · string · chart.saveTemplate.resourceKinds authority extractor · required when constrained
Revision domains	layout
Options index	None

Public SDK signature

(request: SaveTemplateRequest) => Promise<void>

chart.saveUserSettingswrite · write

Persist the current (or supplied) user settings through the storage adapter.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartSettings
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · chart.saveUserSettings.customizationPaths authority extractor · optional when constrained symbols · string · chart.saveUserSettings.symbols authority extractor · required when constrained
Revision domains	settings
Options index	None

Public SDK signature

(request?: Omit<SaveUserSettingsRequest, 'settings'> & { settings?: UserSettingsState }) => Promise<void>

chart.scrollToBarwrite · write

Scroll the viewport so the bar at the given data index is visible, with optional alignment and
animation. Pass the options argument as an object, for example { align: 'left' }, rather than
as a JSON-encoded string.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartNavigation
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	viewport
Options index	None

Public SDK signature

(dataIndex: number, options?: ChartScrollOptions) => Promise<void> | void

chart.scrollToRealTimewrite · write

Scroll the viewport back to the newest bars (the real-time edge), optionally animated.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartNavigation
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	viewport
Options index	None

Public SDK signature

(options?: ChartAnimationOptions) => Promise<void> | void

chart.scrollToTimewrite · write

Scroll the viewport so the bar at the given timestamp is visible, with optional alignment and
animation.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartNavigation
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	viewport
Options index	None

Public SDK signature

(time: number, options?: ChartScrollOptions) => Promise<void> | void

chart.selectDrawingToolwrite · write

Arm a drawing tool for interactive user placement (the programmatic
equivalent of clicking it in a drawing toolbar); null disarms. Emits
'drawing-tool-change'.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartSettings
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	drawingKinds · string · chart.selectDrawingTool.drawingKinds authority extractor · optional when constrained resourceKinds · string · chart.selectDrawingTool.resourceKinds authority extractor · required when constrained
Revision domains	ui
Options index	None

Public SDK signature

(toolId: string | null) => void

chart.selectObjectswrite · write

Select the given chart objects, optionally naming which one is the primary selection.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartSettings
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	drawingKinds · string · chart.selectObjects.drawingKinds authority extractor · optional when constrained resourceIds · string · chart.selectObjects.resourceIds authority extractor · required when constrained resourceKinds · string · chart.selectObjects.resourceKinds authority extractor · required when constrained
Revision domains	ui
Options index	None

Public SDK signature

(objectIds: string[], options?: { primaryObjectId?: string }) => Promise<void> | void

chart.setAlertswrite · write

Replace alerts matching the filter (all when omitted) with the given alert set.

Contract	Value
Controller	chart
Target scopes	chart
Family	objects
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · chart.setAlerts.symbols authority extractor · required when constrained resourceIds · string · chart.setAlerts.resourceIds authority extractor · required when constrained resourceKinds · string · chart.setAlerts.resourceKinds authority extractor · required when constrained
Revision domains	content
Options index	None

Public SDK signature

(alerts: AlertDefinition[], filter?: AlertFilter) => void

chart.setAllDrawingsLockedwrite · write

Bulk lock/unlock of user drawings (marker/alert overlays excluded) as one undoable step.

Contract	Value
Controller	chart
Target scopes	chart
Family	drawings
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	drawingKinds · string · chart.setAllDrawingsLocked.drawingKinds authority extractor · optional when constrained resourceIds · string · chart.setAllDrawingsLocked.resourceIds authority extractor · required when constrained resourceKinds · string · chart.setAllDrawingsLocked.resourceKinds authority extractor · required when constrained
Revision domains	content
Options index	None

Public SDK signature

(locked: boolean) => void

chart.setAllDrawingsVisiblewrite · write

Bulk show/hide of user drawings (marker/alert overlays excluded) as one undoable step.

Contract	Value
Controller	chart
Target scopes	chart
Family	drawings
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	drawingKinds · string · chart.setAllDrawingsVisible.drawingKinds authority extractor · optional when constrained resourceIds · string · chart.setAllDrawingsVisible.resourceIds authority extractor · required when constrained resourceKinds · string · chart.setAllDrawingsVisible.resourceKinds authority extractor · required when constrained
Revision domains	content
Options index	None

Public SDK signature

(visible: boolean) => void

chart.setChartTypewrite · write

Switch the main series to another chart type (e.g. candles, bars, line, area).

Contract	Value
Controller	chart
Target scopes	chart
Family	chartNavigation
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	data
Options index	None

Public SDK signature

(chartType: ChartType) => Promise<void> | void

chart.setComparisonswrite · write

Replace the whole comparison set with the given series.

Contract	Value
Controller	chart
Target scopes	chart
Family	objects
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · chart.setComparisons.symbols authority extractor · required when constrained resourceIds · string · chart.setComparisons.resourceIds authority extractor · required when constrained resourceKinds · string · chart.setComparisons.resourceKinds authority extractor · required when constrained
Revision domains	content
Options index	None

Public SDK signature

(comparisons: AddComparisonOptions[] | ComparisonSeries[]) => Promise<void> | void

chart.setCrosshairwrite · write

Move the crosshair to the given state, or hide it when called with no argument.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartSettings
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	ui
Options index	None

Public SDK signature

(crosshair?: CrosshairState) => Promise<void> | void

chart.setDisplaySettingswrite · write

Apply chart display settings such as last-price visibility, average-close line, and data-window
behavior.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartSettings
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · chart.setDisplaySettings.customizationPaths authority extractor · required when constrained
Revision domains	settings
Options index	None

Public SDK signature

(settings: ChartDisplaySettings) => Promise<void> | void

chart.setDragExportEnabledwrite · write

Enable or disable browser dragstart export events from the chart surface.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartSettings
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	settings
Options index	None

Public SDK signature

(enabled: boolean) => Promise<void> | void

chart.setDrawingLockwrite · write

Lock or unlock one drawing against interactive editing by id.

Contract	Value
Controller	chart
Target scopes	chart
Family	drawings
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	drawingKinds · string · chart.setDrawingLock.drawingKinds authority extractor · required when constrained resourceIds · string · chart.setDrawingLock.resourceIds authority extractor · required when constrained resourceKinds · string · chart.setDrawingLock.resourceKinds authority extractor · required when constrained
Revision domains	content
Options index	None

Public SDK signature

(drawingId: string, locked: boolean) => Promise<void> | void

chart.setDrawingswrite · write

Replace the chart's whole drawing state from a snapshot.

Contract	Value
Controller	chart
Target scopes	chart
Family	drawings
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	drawingKinds · string · chart.setDrawings.drawingKinds authority extractor · optional when constrained resourceIds · string · chart.setDrawings.resourceIds authority extractor · required when constrained resourceKinds · string · chart.setDrawings.resourceKinds authority extractor · required when constrained
Revision domains	content
Options index	None

Public SDK signature

(drawings: DrawingSnapshot) => Promise<void> | void

chart.setDrawingSharingModewrite · write

Switch the collaborative drawing-sharing mode.

Contract	Value
Controller	chart
Target scopes	chart
Family	drawings
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	drawingKinds · string · chart.setDrawingSharingMode.drawingKinds authority extractor · required when constrained resourceIds · string · chart.setDrawingSharingMode.resourceIds authority extractor · required when constrained resourceKinds · string · chart.setDrawingSharingMode.resourceKinds authority extractor · required when constrained
Revision domains	content
Options index	None

Public SDK signature

(mode: DrawingSharingMode) => void

chart.setDrawingVisibilitywrite · write

Show or hide one drawing by id.

Contract	Value
Controller	chart
Target scopes	chart
Family	drawings
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	drawingKinds · string · chart.setDrawingVisibility.drawingKinds authority extractor · required when constrained resourceIds · string · chart.setDrawingVisibility.resourceIds authority extractor · required when constrained resourceKinds · string · chart.setDrawingVisibility.resourceKinds authority extractor · required when constrained
Revision domains	content
Options index	None

Public SDK signature

(drawingId: string, visible: boolean) => Promise<void> | void

chart.setDrawingZOrderwrite · write

Set one drawing's z-index by id.

Contract	Value
Controller	chart
Target scopes	chart
Family	drawings
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	drawingKinds · string · chart.setDrawingZOrder.drawingKinds authority extractor · required when constrained resourceIds · string · chart.setDrawingZOrder.resourceIds authority extractor · required when constrained resourceKinds · string · chart.setDrawingZOrder.resourceKinds authority extractor · required when constrained
Revision domains	content
Options index	None

Public SDK signature

(drawingId: string, zIndex: number) => Promise<void> | void

chart.setFavoriteChartTypewrite · write

Add or remove one chart type from the favorites depending on favorite, returning the resulting
favorites.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartSettings
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	settings
Options index	None

Public SDK signature

(chartType: ChartType, favorite: boolean) => ChartType[]

chart.setFavoriteChartTypeswrite · write

Replace the whole favorite chart-type list and return the resulting favorites.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartSettings
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	settings
Options index	None

Public SDK signature

(chartTypes: readonly ChartType[]) => ChartType[]

chart.setFavoriteDrawingToolwrite · write

Add or remove one drawing tool from the favorites depending on favorite, returning the
resulting favorites.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartSettings
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · chart.setFavoriteDrawingTool.customizationPaths authority extractor · required when constrained drawingKinds · string · chart.setFavoriteDrawingTool.drawingKinds authority extractor · required when constrained resourceKinds · string · chart.setFavoriteDrawingTool.resourceKinds authority extractor · required when constrained chart.setFavoriteDrawingTool.allowedCustomizationDrawing result filter · customizationPaths, drawingKinds
Revision domains	settings
Options index	None

Public SDK signature

(toolId: string, favorite: boolean) => string[]

chart.setFavoriteDrawingToolswrite · write

Replace the whole favorite drawing-tool list and return the resulting favorites.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartSettings
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · chart.setFavoriteDrawingTools.customizationPaths authority extractor · required when constrained drawingKinds · string · chart.setFavoriteDrawingTools.drawingKinds authority extractor · optional when constrained resourceKinds · string · chart.setFavoriteDrawingTools.resourceKinds authority extractor · required when constrained chart.setFavoriteDrawingTools.allowedCustomizationDrawing result filter · customizationPaths, drawingKinds
Revision domains	settings
Options index	None

Public SDK signature

(toolIds: readonly string[]) => string[]

chart.setFavoriteIndicatorwrite · write

Add or remove one indicator from the favorites depending on favorite, returning the resulting
favorites.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartSettings
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceKinds · string · chart.setFavoriteIndicator.resourceKinds authority extractor · required when constrained
Revision domains	settings
Options index	None

Public SDK signature

(indicatorId: string, favorite: boolean) => string[]

chart.setFavoriteIndicatorswrite · write

Replace the whole favorite-indicator list and return the resulting favorites.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartSettings
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceKinds · string · chart.setFavoriteIndicators.resourceKinds authority extractor · required when constrained
Revision domains	settings
Options index	None

Public SDK signature

(indicatorIds: readonly string[]) => string[]

chart.setFavoriteIntervalwrite · write

Add or remove one interval from the favorites depending on favorite, returning the resulting
favorites.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartSettings
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	settings
Options index	None

Public SDK signature

(interval: string, favorite: boolean) => string[]

chart.setFavoriteIntervalswrite · write

Replace the whole favorite-interval list and return the resulting favorites.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartSettings
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	settings
Options index	None

Public SDK signature

(intervals: readonly string[]) => string[]

chart.setFootprintwrite · write

Enable the footprint chart type with the given options, or pass null to turn it off.

Contract	Value
Controller	chart
Target scopes	chart
Family	orderFlow
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceKinds · string · chart.setFootprint.resourceKinds authority extractor · required when constrained
Revision domains	content
Options index	None

Public SDK signature

(options: FootprintChartOptions | null) => void

chart.setIntervalwrite · write

Switches the chart to a new bar interval such as 15m or 1D; may complete asynchronously
while history reloads.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartNavigation
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	data
Options index	None

Public SDK signature

(interval: ChartInterval) => Promise<void> | void

chart.setMagnetModewrite · write

Snap behavior for drawing placement and drags.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartSettings
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · chart.setMagnetMode.customizationPaths authority extractor · required when constrained
Revision domains	settings
Options index	None

Public SDK signature

(mode: MagnetMode) => void

chart.setMarkerswrite · write

Replace markers matching the filter (all when omitted) with the given marker set.

Contract	Value
Controller	chart
Target scopes	chart
Family	objects
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · chart.setMarkers.resourceIds authority extractor · required when constrained resourceKinds · string · chart.setMarkers.resourceKinds authority extractor · required when constrained
Revision domains	content
Options index	None

Public SDK signature

(markers: MarkerDefinition[], filter?: MarkerFilter) => void

chart.setOrderFlowHeatmapwrite · write

Enable/disable the Bookmap-style order-flow liquidity heatmap rendered beneath
the candles. Requires the datafeed to implement subscribeDepth (and, for trade
bubbles, subscribeTimeAndSales). Pass { enabled: false } or null to turn off.

Contract	Value
Controller	chart
Target scopes	chart
Family	orderFlow
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceKinds · string · chart.setOrderFlowHeatmap.resourceKinds authority extractor · required when constrained
Revision domains	content
Options index	None

Public SDK signature

(options: OrderFlowHeatmapOptions | null) => void

chart.setPaneHeightwrite · write

Set one pane's height in CSS pixels and return the resulting layout.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartLayouts
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · chart.setPaneHeight.resourceIds authority extractor · required when constrained resourceKinds · string · chart.setPaneHeight.resourceKinds authority extractor · required when constrained
Revision domains	layout
Options index	None

Public SDK signature

(paneId: string, height: number) => PaneLayoutItem[]

chart.setPaneHeightswrite · write

Set multiple pane heights at once (patch list or id-to-height record) and return the resulting
layout.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartLayouts
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · chart.setPaneHeights.resourceIds authority extractor · required when constrained resourceKinds · string · chart.setPaneHeights.resourceKinds authority extractor · required when constrained
Revision domains	layout
Options index	None

Public SDK signature

(heights: readonly PaneHeightPatch[] | Record<string, number>) => PaneLayoutItem[]

chart.setPaneOrderwrite · write

Reorder panes to the given id sequence and return the resulting layout.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartLayouts
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · chart.setPaneOrder.resourceIds authority extractor · required when constrained resourceKinds · string · chart.setPaneOrder.resourceKinds authority extractor · required when constrained
Revision domains	layout
Options index	None

Public SDK signature

(paneIds: string[]) => PaneLayoutItem[]

chart.setPaneVisiblePriceRangewrite · write

Pin one pane-and-scale visible value range; null restores that scale's native auto-fit.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartNavigation
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · chart.setPaneVisiblePriceRange.resourceIds authority extractor · required when constrained resourceKinds · string · chart.setPaneVisiblePriceRange.resourceKinds authority extractor · required when constrained
Revision domains	viewport
Options index	None

Public SDK signature

(paneId: string, range: PriceRange | null, scaleId?: string) => Promise<void> | void

chart.setPriceScalewrite · write

Apply price-scale settings such as scale mode and auto-scaling behavior.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartNavigation
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · chart.setPriceScale.resourceIds authority extractor · required when constrained resourceKinds · string · chart.setPriceScale.resourceKinds authority extractor · required when constrained
Revision domains	viewport
Options index	None

Public SDK signature

(settings: PriceScaleSettings) => Promise<void> | void

chart.setPriceScaleSlotswrite · write

Replace the host-defined price-scale slot definitions and return the resulting slots.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartNavigation
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · chart.setPriceScaleSlots.resourceIds authority extractor · required when constrained resourceKinds · string · chart.setPriceScaleSlots.resourceKinds authority extractor · required when constrained
Revision domains	viewport
Options index	None

Public SDK signature

(slots: PriceScaleSlotDefinition[]) => PriceScaleSlotDefinition[]

chart.setPriceToBarRatiowrite · write

Fix the price-to-bar geometry ratio, or pass null to clear it; optionally excluded from undo
history.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartNavigation
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	viewport
Options index	None

Public SDK signature

(value: number | null, options?: UndoOptions) => Promise<void> | void

chart.setPriceToBarRatioLockedwrite · write

Lock or unlock the price-to-bar ratio against interactive changes; optionally excluded from undo
history.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartNavigation
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	viewport
Options index	None

Public SDK signature

(value: boolean, options?: UndoOptions) => Promise<void> | void

chart.setSmartDrawingAnchorwrite · write

Move a placed set's drawn anchor; the tool recomputes within the new span.

Contract	Value
Controller	chart
Target scopes	chart
Family	objects
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	content
Options index	None

Public SDK signature

(placementId: string, anchor: SmartDrawingAnchor) => void

chart.setSmartDrawingEnabledwrite · write

Programmatic on/off for hosts and restores. true places one set only when
the tool has none, so restoring never stacks duplicates; false erases
every set. Interactive picking uses addSmartDrawing, which always adds.

Contract	Value
Controller	chart
Target scopes	chart
Family	objects
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	content
Options index	None

Public SDK signature

(toolId: SmartDrawingToolId, enabled: boolean) => void

chart.setStatewrite · write

Restores a previously captured ChartState snapshot onto the chart; may complete
asynchronously.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartSettings
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · chart.setState.customizationPaths authority extractor · optional when constrained drawingKinds · string · chart.setState.drawingKinds authority extractor · optional when constrained symbols · string · chart.setState.symbols authority extractor · required when constrained resourceIds · string · chart.setState.resourceIds authority extractor · required when constrained resourceKinds · string · chart.setState.resourceKinds authority extractor · required when constrained
Revision domains	data, viewport, content, settings, replay, ui
Options index	None

Public SDK signature

(state: ChartState) => Promise<void> | void

chart.setSymbolwrite · write

Switches the chart to a new symbol, given a ticker string or an already-resolved
SdkSymbolInfo; may complete asynchronously while data reloads.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartNavigation
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · chart.setSymbol.symbols authority extractor · required when constrained
Revision domains	data
Options index	None

Public SDK signature

(symbol: string | SdkSymbolInfo) => Promise<void> | void

chart.setTimeFramewrite · write

Apply a time-frame preset by id or definition, adjusting interval and visible range together.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartNavigation
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	data
Options index	None

Public SDK signature

(timeFrame: string | TimeFrameDefinition) => Promise<void> | void

chart.setUserSettingwrite · write

Set one user-settings key to a value.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartSettings
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · chart.setUserSetting.customizationPaths authority extractor · required when constrained
Revision domains	settings
Options index	None

Public SDK signature

(key: string, value: unknown) => Promise<void> | void

chart.setUserSettingswrite · write

Replace the in-memory user-settings state wholesale.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartSettings
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · chart.setUserSettings.customizationPaths authority extractor · optional when constrained
Revision domains	settings
Options index	None

Public SDK signature

(settings: UserSettingsState) => Promise<void> | void

chart.setVisibleRangewrite · write

Set the visible time range of the chart viewport.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartNavigation
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	viewport
Options index	None

Public SDK signature

(range: VisibleTimeRange) => Promise<void> | void

chart.setWidgetRailStatewrite · write

Replace the widget rail state wholesale.

Contract	Value
Controller	chart
Target scopes	chart
Family	terminalLayout
Implementation	sdk
Permission label	host.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · chart.setWidgetRailState.resourceIds authority extractor · required when constrained resourceKinds · string · chart.setWidgetRailState.resourceKinds authority extractor · required when constrained
Revision domains	ui
Options index	None

Public SDK signature

(state: WidgetRailState) => void

chart.showConfirmDialogwrite · write

Open a widget-hosted confirmation dialog and resolve with the user's choice.

Contract	Value
Controller	chart
Target scopes	chart
Family	terminalLayout
Implementation	sdk
Permission label	host.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	ui
Options index	None

Public SDK signature

(params: ChartConfirmDialogParams) => Promise<boolean>

chart.showNoticeDialogwrite · write

Open a widget-hosted notice dialog and resolve when it closes.

Contract	Value
Controller	chart
Target scopes	chart
Family	terminalLayout
Implementation	sdk
Permission label	host.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	ui
Options index	None

Public SDK signature

(params: ChartNoticeDialogParams) => Promise<void>

chart.showPropertiesDialogwrite · write

Open a native properties editor for an entity id returned by listObjects/getObject. Resolves false when no native editor owns that entity.

Contract	Value
Controller	chart
Target scopes	chart
Family	terminalLayout
Implementation	sdk
Permission label	host.control
Financial risk classes	None
Decision receipt	None
Input constraints	drawingKinds · string · chart.showPropertiesDialog.drawingKinds authority extractor · optional when constrained resourceIds · string · chart.showPropertiesDialog.resourceIds authority extractor · required when constrained resourceKinds · string · chart.showPropertiesDialog.resourceKinds authority extractor · required when constrained
Revision domains	ui
Options index	None

Public SDK signature

(entityId: string, options?: ChartPropertiesDialogOptions) => Promise<boolean>

chart.showTimeRangewrite · write

Show a duration ending at the latest chart bar without changing interval. Loads missing history first and returns coverage plus the actual viewport. Two weeks is 1209600000 ms.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartNavigation
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · bars catalog literal · required when constrained maxHistoryLookbackMs · finite-number · args[0] · required when constrained; absolute magnitude chart.showTimeRange.allowedSymbols result filter · symbols
Revision domains	data, viewport
Options index	None

Public SDK signature

(durationMs: number, maxPages?: number) => Promise<ChartTimeRangeResult>

chart.snapshotread · read

Capture one chart through the registered bounded snapshot authority.

Contract	Value
Controller	chart
Target scopes	chart
Family	chart
Implementation	projection
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · chart.snapshot.customizationPaths authority extractor · required when constrained drawingKinds · string · chart.snapshot.drawingKinds authority extractor · required when constrained resourceIds · string · chart.snapshot.resourceConstraintUnavailable authority extractor · required when constrained resourceKinds · string · chart.snapshot.resourceConstraintUnavailable authority extractor · required when constrained chart.snapshot.allowedSymbols result filter · symbols
Revision domains	None
Options index	None

Public SDK signature

(options?: WidgetImageExportOptions) => Promise<AgenticSnapshotResult>

chart.toggleFavoriteChartTypewrite · write

Flip one chart type's favorite status and return the resulting favorites.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartSettings
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	settings
Options index	None

Public SDK signature

(chartType: ChartType) => ChartType[]

chart.toggleFavoriteDrawingToolwrite · write

Flip one drawing tool's favorite status and return the resulting favorites.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartSettings
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · chart.toggleFavoriteDrawingTool.customizationPaths authority extractor · required when constrained drawingKinds · string · chart.toggleFavoriteDrawingTool.drawingKinds authority extractor · required when constrained resourceKinds · string · chart.toggleFavoriteDrawingTool.resourceKinds authority extractor · required when constrained chart.toggleFavoriteDrawingTool.allowedCustomizationDrawing result filter · customizationPaths, drawingKinds
Revision domains	settings
Options index	None

Public SDK signature

(toolId: string) => string[]

chart.toggleFavoriteIndicatorwrite · write

Flip one indicator's favorite status and return the resulting favorites.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartSettings
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceKinds · string · chart.toggleFavoriteIndicator.resourceKinds authority extractor · required when constrained
Revision domains	settings
Options index	None

Public SDK signature

(indicatorId: string) => string[]

chart.toggleFavoriteIntervalwrite · write

Flip one interval's favorite status and return the resulting favorites.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartSettings
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	settings
Options index	None

Public SDK signature

(interval: string) => string[]

chart.undowrite · write

Undo the most recent content change (drawings, indicators, comparisons). Resolves true when a change was reverted.

Contract	Value
Controller	chart
Target scopes	chart
Family	objects
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · chart.undo.customizationPaths authority extractor · required when constrained drawingKinds · string · chart.undo.drawingKinds authority extractor · required when constrained resourceIds · string · chart.undo.resourceConstraintUnavailable authority extractor · required when constrained resourceKinds · string · chart.undo.resourceConstraintUnavailable authority extractor · required when constrained
Revision domains	content, ui
Options index	None

Public SDK signature

() => Promise<boolean>

chart.ungroupDrawingswrite · write

Dissolve a drawing group, clearing membership for its drawings.

Contract	Value
Controller	chart
Target scopes	chart
Family	drawings
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	drawingKinds · string · chart.ungroupDrawings.drawingKinds authority extractor · optional when constrained resourceIds · string · chart.ungroupDrawings.resourceIds authority extractor · required when constrained resourceKinds · string · chart.ungroupDrawings.resourceKinds authority extractor · required when constrained
Revision domains	content
Options index	None

Public SDK signature

(groupId: string) => Promise<void> | void

chart.updateAlertwrite · write

Apply a patch (price, condition, styles, etc.) to an existing alert by id.

Contract	Value
Controller	chart
Target scopes	chart
Family	objects
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · chart.updateAlert.resourceIds authority extractor · required when constrained resourceKinds · string · chart.updateAlert.resourceKinds authority extractor · required when constrained
Revision domains	content
Options index	None

Public SDK signature

(alertId: string, patch: AlertPatch) => void

chart.updateBuiltInIndicatorPropertieswrite · write

Apply a strict catalog-validated properties patch to an existing native built-in indicator.

Contract	Value
Controller	chart
Target scopes	chart
Family	indicators
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · chart.updateBuiltInIndicatorProperties.resourceIds authority extractor · required when constrained resourceKinds · string · chart.updateBuiltInIndicatorProperties.resourceKinds authority extractor · required when constrained
Revision domains	content
Options index	None

Public SDK signature

(indicatorId: string, patch: IndicatorPropertiesPatch) => Promise<void> | void

chart.updateComparisonwrite · write

Apply a patch to an existing comparison series by id.

Contract	Value
Controller	chart
Target scopes	chart
Family	objects
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · chart.updateComparison.symbols authority extractor · required when constrained resourceIds · string · chart.updateComparison.resourceIds authority extractor · required when constrained resourceKinds · string · chart.updateComparison.resourceKinds authority extractor · required when constrained
Revision domains	content
Options index	None

Public SDK signature

(comparisonId: string, patch: UpdateComparisonOptions) => Promise<void> | void

chart.updateDrawingwrite · write

Apply a patch (points, styles, lock, etc.) to an existing drawing by id.

Contract	Value
Controller	chart
Target scopes	chart
Family	drawings
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	drawingKinds · string · chart.updateDrawing.drawingKinds authority extractor · required when constrained resourceIds · string · chart.updateDrawing.resourceIds authority extractor · required when constrained resourceKinds · string · chart.updateDrawing.resourceKinds authority extractor · required when constrained
Revision domains	content
Options index	None

Public SDK signature

(drawingId: string, patch: DrawingPatch) => Promise<void> | void

chart.updateDrawingPropertieswrite · write

Strict native drawing-property patch. Style fields are validated against the
drawing tool catalog and nested styles / metadata records are deep merged.

Contract	Value
Controller	chart
Target scopes	chart
Family	drawings
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	drawingKinds · string · chart.updateDrawingProperties.drawingKinds authority extractor · required when constrained resourceIds · string · chart.updateDrawingProperties.resourceIds authority extractor · required when constrained resourceKinds · string · chart.updateDrawingProperties.resourceKinds authority extractor · required when constrained
Revision domains	content
Options index	None

Public SDK signature

(drawingId: string, patch: DrawingPropertiesPatch) => Promise<void> | void

chart.updateDrawingRuntimeMetadatawrite · write

Patch transient drawing metadata for live renderer state without recording undo/history.

Contract	Value
Controller	chart
Target scopes	chart
Family	drawings
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	drawingKinds · string · chart.updateDrawingRuntimeMetadata.drawingKinds authority extractor · required when constrained resourceIds · string · chart.updateDrawingRuntimeMetadata.resourceIds authority extractor · required when constrained resourceKinds · string · chart.updateDrawingRuntimeMetadata.resourceKinds authority extractor · required when constrained
Revision domains	content
Options index	None

Public SDK signature

(drawingId: string, metadata: Record<string, unknown>) => Promise<void> | void

chart.updateIndicatorwrite · write

Apply a partial definition patch to an existing indicator by id.

Contract	Value
Controller	chart
Target scopes	chart
Family	indicators
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · chart.updateIndicator.resourceIds authority extractor · required when constrained resourceKinds · string · chart.updateIndicator.resourceKinds authority extractor · required when constrained
Revision domains	content
Options index	None

Public SDK signature

(indicatorId: string, indicator: Partial<IndicatorDefinition>) => Promise<void> | void

chart.updateMarkerwrite · write

Apply a patch to an existing marker by id.

Contract	Value
Controller	chart
Target scopes	chart
Family	objects
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · chart.updateMarker.resourceIds authority extractor · required when constrained resourceKinds · string · chart.updateMarker.resourceKinds authority extractor · required when constrained
Revision domains	content
Options index	None

Public SDK signature

(markerId: string, patch: MarkerPatch) => void

chart.updateObjectwrite · write

Apply a patch (name, visibility, lock, etc.) to a chart object by id.

Contract	Value
Controller	chart
Target scopes	chart
Family	objects
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	drawingKinds · string · chart.updateObject.drawingKinds authority extractor · optional when constrained resourceIds · string · chart.updateObject.resourceIds authority extractor · required when constrained resourceKinds · string · chart.updateObject.resourceKinds authority extractor · required when constrained
Revision domains	content
Options index	None

Public SDK signature

(objectId: string, patch: ChartObjectPatch) => Promise<void> | void

chart.updatePriceScaleSlotwrite · write

Patch one price-scale slot by id and return the updated definition.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartNavigation
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · chart.updatePriceScaleSlot.resourceIds authority extractor · required when constrained resourceKinds · string · chart.updatePriceScaleSlot.resourceKinds authority extractor · required when constrained
Revision domains	viewport
Options index	None

Public SDK signature

(slotId: string, patch: PriceScaleSlotPatch) => PriceScaleSlotDefinition

chart.updateSmartDrawingSettingswrite · write

Merge settings into one tool and recompute.

Contract	Value
Controller	chart
Target scopes	chart
Family	objects
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	content
Options index	None

Public SDK signature

<TToolId extends SmartDrawingToolId>(
    toolId: TToolId,
    settings: SmartDrawingToolSettingsMap[TToolId],
  ) => void

chart.updateTradingLinewrite · write

Apply a kind-preserving patch by stable id. Missing ids or kind changes fail; an equivalent
patch is a no-op and does not emit trading-line-change.

Contract	Value
Controller	chart
Target scopes	chart
Family	orderEntry
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · chart.updateTradingLine.resourceIds authority extractor · required when constrained resourceKinds · string · chart.updateTradingLine.resourceKinds authority extractor · required when constrained
Revision domains	trading
Options index	None

Public SDK signature

(tradingLineId: string, patch: TradingLinePatch) => void

chart.uploadSnapshotwrite · write

Render a chart snapshot and upload it through the configured snapshot backend, resolving with
the upload result; optional metadata is attached to the snapshot.

Contract	Value
Controller	chart
Target scopes	chart
Family	terminalLayout
Implementation	sdk
Permission label	host.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · chart.uploadSnapshot.customizationPaths authority extractor · required when constrained drawingKinds · string · chart.uploadSnapshot.drawingKinds authority extractor · optional when constrained resourceIds · string · chart.uploadSnapshot.resourceConstraintUnavailable authority extractor · required when constrained resourceKinds · string · chart.uploadSnapshot.resourceConstraintUnavailable authority extractor · required when constrained chart.uploadSnapshot.allowedSymbols result filter · symbols
Revision domains	None
Options index	None

Public SDK signature

(options?: ChartImageExportOptions & { metadata?: Record<string, unknown> }) => Promise<SnapshotUploadResult>

chart.zoomwrite · write

Zoom around the native viewport anchor. The optional factor is greater than 1 for either direction. No candle data is required.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartNavigation
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	viewport
Options index	None

Public SDK signature

(direction: 'in' | 'out', factor?: number) => void

chart.zoomAtBarwrite · write

Zoom the time scale by the numeric scale anchored at the bar with the given data index, optionally
animated. A scale between 0 and 1 zooms out; a scale greater than 1 zooms in.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartNavigation
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	viewport
Options index	None

Public SDK signature

(dataIndex: number, scale: number, options?: ChartAnimationOptions) => Promise<void> | void

chart.zoomAtCoordinatewrite · write

Zoom the time scale by the numeric scale anchored at a pixel coordinate (viewport center when omitted),
optionally animated. A scale between 0 and 1 zooms out; a scale greater than 1 zooms in.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartNavigation
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	viewport
Options index	None

Public SDK signature

(scale: number, coordinate?: ChartPoint, options?: ChartAnimationOptions) => Promise<void> | void

chart.zoomAtTimewrite · write

Zoom the time scale by the numeric scale anchored at the bar with the given timestamp, optionally
animated. A scale between 0 and 1 zooms out; a scale greater than 1 zooms in.

Contract	Value
Controller	chart
Target scopes	chart
Family	chartNavigation
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	viewport
Options index	None

Public SDK signature

(time: number, scale: number, options?: ChartAnimationOptions) => Promise<void> | void

chartLayouts.createwrite · write

Applies the given chart layout to the workspace and persists it as a new storage record,
re-applying the previous chart layout if the save fails; resolves with the normalized save
result.

Contract	Value
Controller	chartLayouts
Target scopes	widget
Family	chartLayouts
Implementation	sdk
Permission label	workspace.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · chartLayouts.create.customizationPaths authority extractor · required when constrained drawingKinds · string · chartLayouts.create.drawingKinds authority extractor · optional when constrained symbols · string · chartLayouts.create.symbols authority extractor · required when constrained resourceIds · string · chartLayouts.create.resourceIds authority extractor · required when constrained resourceKinds · string · chartLayouts.create.resourceKinds authority extractor · required when constrained
Revision domains	data, viewport, content, layout, settings, replay, ui
Options index	None

Public SDK signature

(layout: ChartLayout) => Promise<SaveLayoutResult>

chartLayouts.deletewrite · write

Deletes a saved chart layout from storage.

Contract	Value
Controller	chartLayouts
Target scopes	widget
Family	chartLayouts
Implementation	sdk
Permission label	workspace.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · chartLayouts.delete.customizationPaths authority extractor · required when constrained drawingKinds · string · chartLayouts.delete.drawingKinds authority extractor · required when constrained resourceIds · string · chartLayouts.delete.resourceIds authority extractor · required when constrained resourceKinds · string · chartLayouts.delete.resourceKinds authority extractor · required when constrained
Revision domains	layout
Options index	None

Public SDK signature

(layoutId: ChartLayoutId) => Promise<void>

chartLayouts.getLayoutread · read

Captures the current live workspace as a ChartLayout, embedding drawings unless the drawing
persistence mode is separate.

Contract	Value
Controller	chartLayouts
Target scopes	widget
Family	workspace
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	chartLayouts.getLayout.allowedCustomizationDrawing result filter · customizationPaths, drawingKinds chartLayouts.getLayout.allowedSymbols result filter · symbols chartLayouts.getLayout.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

() => ChartLayout

chartLayouts.getStorageIdsread · read

Returns the mapping from logical chart-layout ids to the backend storage ids they were saved
under, so hosts can persist it across sessions.

Contract	Value
Controller	chartLayouts
Target scopes	widget
Family	workspace
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	chartLayouts.getStorageIds.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

() => Record<ChartLayoutId, ChartLayoutId>

chartLayouts.initializeLastLayoutwrite · write

One-shot startup restore driven by the loadLastChart value: loads the requested or newest
saved chart layout, applies it (optionally preserving current symbols), and resolves with the
applied chart layout, or null when disabled, already run, or nothing is saved.

Contract	Value
Controller	chartLayouts
Target scopes	widget
Family	chartLayouts
Implementation	sdk
Permission label	workspace.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · chartLayouts.initializeLastLayout.customizationPaths authority extractor · required when constrained drawingKinds · string · chartLayouts.initializeLastLayout.drawingKinds authority extractor · required when constrained symbols · string · chartLayouts.initializeLastLayout.symbols authority extractor · required when constrained resourceIds · string · chartLayouts.initializeLastLayout.resourceConstraintUnavailable authority extractor · required when constrained resourceKinds · string · chartLayouts.initializeLastLayout.resourceConstraintUnavailable authority extractor · required when constrained chartLayouts.initializeLastLayout.allowedCustomizationDrawing result filter · customizationPaths, drawingKinds chartLayouts.initializeLastLayout.allowedSymbols result filter · symbols
Revision domains	data, viewport, content, layout, settings, replay, ui
Options index	None

Public SDK signature

(value: boolean | LoadLastChartSettings | undefined) => Promise<ChartLayout | null>

chartLayouts.listread · read

Lists saved chart-layout summaries through the storage adapter, remapping backend storage ids
to logical chart-layout ids and exposing the raw storage id in each summary's
metadata.storageId;
resolves to an empty array when the adapter cannot list.

Contract	Value
Controller	chartLayouts
Target scopes	widget
Family	workspace
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · chartLayouts.list.symbols authority extractor · optional when constrained resourceIds · string · chartLayouts.list.resourceIds authority extractor · required when constrained resourceKinds · string · chartLayouts.list.resourceKinds authority extractor · required when constrained chartLayouts.list.allowedSymbols result filter · symbols chartLayouts.list.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

(request?: ListLayoutsRequest) => Promise<ChartLayoutSummary[]>

chartLayouts.loadwrite · write

Loads a saved chart layout by logical id (mapped through known storage ids), applies it to the
workspace, and resolves with the chart layout, or null when storage has no chart layout for
the id.

Contract	Value
Controller	chartLayouts
Target scopes	widget
Family	chartLayouts
Implementation	sdk
Permission label	workspace.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · chartLayouts.load.customizationPaths authority extractor · required when constrained drawingKinds · string · chartLayouts.load.drawingKinds authority extractor · required when constrained resourceIds · string · chartLayouts.load.resourceConstraintUnavailable authority extractor · required when constrained resourceKinds · string · chartLayouts.load.resourceConstraintUnavailable authority extractor · required when constrained chartLayouts.load.allowedCustomizationDrawing result filter · customizationPaths, drawingKinds chartLayouts.load.allowedSymbols result filter · symbols
Revision domains	data, viewport, content, layout, settings, replay, ui
Options index	None

Public SDK signature

(layoutId: ChartLayoutId) => Promise<ChartLayout | null>

chartLayouts.renamewrite · write

Renames a saved chart layout: the active chart layout is renamed live and re-saved, while other
chart layouts are loaded from storage and rewritten with the new name.

Contract	Value
Controller	chartLayouts
Target scopes	widget
Family	chartLayouts
Implementation	sdk
Permission label	workspace.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · chartLayouts.rename.resourceIds authority extractor · required when constrained resourceKinds · string · chartLayouts.rename.resourceKinds authority extractor · required when constrained
Revision domains	layout
Options index	None

Public SDK signature

(layoutId: ChartLayoutId, name: string) => Promise<void>

chartLayouts.restoreStorageIdswrite · write

Re-seeds the logical-to-storage id mapping from a record previously captured with
getStorageIds; undefined input and empty entries are ignored.

Contract	Value
Controller	chartLayouts
Target scopes	widget
Family	chartLayouts
Implementation	sdk
Permission label	workspace.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · chartLayouts.restoreStorageIds.resourceIds authority extractor · required when constrained resourceKinds · string · chartLayouts.restoreStorageIds.resourceKinds authority extractor · required when constrained
Revision domains	layout
Options index	None

Public SDK signature

(storageIds: Record<ChartLayoutId, ChartLayoutId> | undefined) => void

chartLayouts.savewrite · write

Persists the workspace under the given chart-layout id (defaults to the current chart layout's
id), choosing create or update from the known storage id; pass create: true to force a new
storage record.

Contract	Value
Controller	chartLayouts
Target scopes	widget
Family	chartLayouts
Implementation	sdk
Permission label	workspace.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · chartLayouts.save.customizationPaths authority extractor · optional when constrained drawingKinds · string · chartLayouts.save.drawingKinds authority extractor · optional when constrained resourceIds · string · chartLayouts.save.resourceIds authority extractor · required when constrained resourceKinds · string · chartLayouts.save.resourceKinds authority extractor · required when constrained
Revision domains	layout
Options index	None

Public SDK signature

(layoutId?: ChartLayoutId, options?: { create?: boolean }) => Promise<SaveLayoutResult>

chartLayouts.saveAswrite · write

Re-identifies the live chart workspace under a new chart-layout id and optional name, applies
it, and persists it, creating a new storage record when the id has no known storage id.

Contract	Value
Controller	chartLayouts
Target scopes	widget
Family	chartLayouts
Implementation	sdk
Permission label	workspace.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · chartLayouts.saveAs.customizationPaths authority extractor · optional when constrained drawingKinds · string · chartLayouts.saveAs.drawingKinds authority extractor · optional when constrained resourceIds · string · chartLayouts.saveAs.resourceIds authority extractor · required when constrained resourceKinds · string · chartLayouts.saveAs.resourceKinds authority extractor · required when constrained
Revision domains	data, viewport, content, layout, settings, replay, ui
Options index	None

Public SDK signature

(layoutId: ChartLayoutId, name?: string) => Promise<SaveLayoutResult>

customization.applyOverrideswrite · write

Applies chart-level override settings; the result is readable back via getOverrides and
emitted as an overrides-change event.

Contract	Value
Controller	customization
Target scopes	chart
Family	customization
Implementation	sdk
Permission label	customization.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · args[0] object leaf paths · required when constrained
Revision domains	settings
Options index	None

Public SDK signature

(overrides: ChartOverrideSettings) => Promise<void> | void

customization.applyStyleOverrideswrite · write

Applies global native renderer style overrides (background, crosshair, indicators, drawings, and
related buckets).

Contract	Value
Controller	customization
Target scopes	chart
Family	customization
Implementation	sdk
Permission label	customization.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · args[0] object leaf paths · required when constrained
Revision domains	settings
Options index	None

Public SDK signature

(overrides: StyleOverrideSettings) => Promise<void> | void

customization.applyThemewrite · write

Applies a previously registered theme by its registry name.

Contract	Value
Controller	customization
Target scopes	chart
Family	customization
Implementation	sdk
Permission label	customization.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · customization.applyTheme.customizationPaths authority extractor · required when constrained
Revision domains	settings
Options index	None

Public SDK signature

(name: string) => Promise<void> | void

customization.clearDrawingDefaultStyleswrite · write

Clears stored drawing defaults for one tool id, or for every tool when toolId is omitted.

Contract	Value
Controller	customization
Target scopes	chart
Family	customization
Implementation	sdk
Permission label	customization.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · customization.clearDrawingDefaultStyles.customizationPaths authority extractor · optional when constrained drawingKinds · string · customization.clearDrawingDefaultStyles.drawingKinds authority extractor · optional when constrained resourceKinds · string · customization.clearDrawingDefaultStyles.resourceKinds authority extractor · required when constrained
Revision domains	settings
Options index	None

Public SDK signature

(toolId?: string) => Promise<void> | void

customization.clearIndicatorDefaultswrite · write

Clears stored indicator defaults for one indicator name, or for every indicator when
indicatorName is omitted.

Contract	Value
Controller	customization
Target scopes	chart
Family	customization
Implementation	sdk
Permission label	customization.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · customization.clearIndicatorDefaults.customizationPaths authority extractor · optional when constrained resourceKinds · string · customization.clearIndicatorDefaults.resourceKinds authority extractor · required when constrained
Revision domains	settings
Options index	None

Public SDK signature

(indicatorName?: string) => Promise<void> | void

customization.getAllDrawingDefaultStylesread · read

Returns every stored drawing default keyed by exact drawing tool id.

Contract	Value
Controller	customization
Target scopes	chart
Family	customization
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	customization.getAllDrawingDefaultStyles.allowedCustomizationDrawing result filter · customizationPaths, drawingKinds customization.getAllDrawingDefaultStyles.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

() => DrawingDefaultStyleMap

customization.getAllIndicatorDefaultsread · read

Returns every stored indicator default keyed by exact indicator name.

Contract	Value
Controller	customization
Target scopes	chart
Family	customization
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	customization.getAllIndicatorDefaults.allowedCustomizationDrawing result filter · customizationPaths customization.getAllIndicatorDefaults.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

() => IndicatorDefaultSettingsMap

customization.getCandleColorsread · read

Returns the current CandleColorSettings.

Contract	Value
Controller	customization
Target scopes	chart
Family	customization
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	customization.getCandleColors.allowedCustomizationDrawing result filter · customizationPaths
Revision domains	None
Options index	None

Public SDK signature

() => CandleColorSettings

customization.getContextMenuread · read

Returns the current ContextMenuCustomization.

Contract	Value
Controller	customization
Target scopes	chart
Family	customization
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	customization.getContextMenu.allowedCustomizationDrawing result filter · customizationPaths
Revision domains	None
Options index	None

Public SDK signature

() => ContextMenuCustomization

customization.getCustomizationStateread · read

Returns the current aggregated CustomizationState snapshot covering theme, localization,
overrides, defaults, and registered actions.

Contract	Value
Controller	customization
Target scopes	chart
Family	customization
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	customization.getCustomizationState.allowedCustomizationDrawing result filter · customizationPaths, drawingKinds customization.getCustomizationState.allowedSymbols result filter · symbols customization.getCustomizationState.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

() => CustomizationState

customization.getDrawingDefaultStylesread · read

Returns the stored default styles for the exact drawing tool id toolId.

Contract	Value
Controller	customization
Target scopes	chart
Family	customization
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	drawingKinds · string · customization.getDrawingDefaultStyles.drawingKinds authority extractor · required when constrained resourceKinds · string · customization.getDrawingDefaultStyles.resourceKinds authority extractor · required when constrained customization.getDrawingDefaultStyles.allowedCustomizationDrawing result filter · customizationPaths, drawingKinds customization.getDrawingDefaultStyles.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

(toolId: string) => DrawingDefaultStyleSettings

customization.getIndicatorDefaultsread · read

Returns the stored defaults for the exact indicator name indicatorName.

Contract	Value
Controller	customization
Target scopes	chart
Family	customization
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	resourceKinds · string · customization.getIndicatorDefaults.resourceKinds authority extractor · required when constrained customization.getIndicatorDefaults.allowedCustomizationDrawing result filter · customizationPaths customization.getIndicatorDefaults.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

(indicatorName: string) => IndicatorDefaultSettings

customization.getLegendread · read

Returns the current LegendSettings.

Contract	Value
Controller	customization
Target scopes	chart
Family	customization
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	customization.getLegend.allowedCustomizationDrawing result filter · customizationPaths customization.getLegend.allowedSymbols result filter · symbols
Revision domains	None
Options index	None

Public SDK signature

() => LegendSettings

customization.getLocaleread · read

Returns the active locale identifier, or undefined when none is set.

Contract	Value
Controller	customization
Target scopes	chart
Family	customization
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	customization.getLocale.allowedCustomizationDrawing result filter · customizationPaths
Revision domains	None
Options index	None

Public SDK signature

() => string | undefined

customization.getLocalizationread · read

Returns the current LocalizationSettings.

Contract	Value
Controller	customization
Target scopes	chart
Family	customization
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	customization.getLocalization.allowedCustomizationDrawing result filter · customizationPaths
Revision domains	None
Options index	None

Public SDK signature

() => LocalizationSettings

customization.getOverridesread · read

Returns the currently applied ChartOverrideSettings.

Contract	Value
Controller	customization
Target scopes	chart
Family	customization
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	customization.getOverrides.allowedCustomizationDrawing result filter · customizationPaths
Revision domains	None
Options index	None

Public SDK signature

() => ChartOverrideSettings

customization.getShortcutsread · read

Returns the current ShortcutSettings.

Contract	Value
Controller	customization
Target scopes	chart
Family	customization
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	customization.getShortcuts.allowedCustomizationDrawing result filter · customizationPaths
Revision domains	None
Options index	None

Public SDK signature

() => ShortcutSettings

customization.getStyleOverridesread · read

Returns the currently applied StyleOverrideSettings.

Contract	Value
Controller	customization
Target scopes	chart
Family	customization
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	customization.getStyleOverrides.allowedCustomizationDrawing result filter · customizationPaths
Revision domains	None
Options index	None

Public SDK signature

() => StyleOverrideSettings

customization.getThemeread · read

Returns the currently applied theme name or object, or undefined when no theme has been set.

Contract	Value
Controller	customization
Target scopes	chart
Family	customization
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	customization.getTheme.allowedCustomizationDrawing result filter · customizationPaths
Revision domains	None
Options index	None

Public SDK signature

() => ChartThemeName | ChartTheme | undefined

customization.getThemeRegistryread · read

Returns the current ChartThemeRegistry of registered named themes.

Contract	Value
Controller	customization
Target scopes	chart
Family	customization
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	customization.getThemeRegistry.allowedCustomizationDrawing result filter · customizationPaths
Revision domains	None
Options index	None

Public SDK signature

() => ChartThemeRegistry

customization.getTimezoneread · read

Returns the active timezone identifier, or undefined when none is set.

Contract	Value
Controller	customization
Target scopes	chart
Family	customization
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	customization.getTimezone.allowedCustomizationDrawing result filter · customizationPaths
Revision domains	None
Options index	None

Public SDK signature

() => string | undefined

customization.getToolbarread · read

Returns the current ToolbarCustomization.

Contract	Value
Controller	customization
Target scopes	chart
Family	customization
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	customization.getToolbar.allowedCustomizationDrawing result filter · customizationPaths
Revision domains	None
Options index	None

Public SDK signature

() => ToolbarCustomization

customization.getTooltipFormattingread · read

Returns the current TooltipFormattingSettings.

Contract	Value
Controller	customization
Target scopes	chart
Family	customization
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	customization.getTooltipFormatting.allowedCustomizationDrawing result filter · customizationPaths
Revision domains	None
Options index	None

Public SDK signature

() => TooltipFormattingSettings

customization.getWatermarkread · read

Returns the current watermark settings, or undefined when none are set.

Contract	Value
Controller	customization
Target scopes	chart
Family	customization
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	customization.getWatermark.allowedCustomizationDrawing result filter · customizationPaths
Revision domains	None
Options index	None

Public SDK signature

() => WatermarkSettings | undefined

customization.listActionsread · read

Returns every custom action currently registered with the controller.

Contract	Value
Controller	customization
Target scopes	chart
Family	customization
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	customization.listActions.allowedCustomizationDrawing result filter · customizationPaths
Revision domains	None
Options index	None

Public SDK signature

() => CustomActionDefinition[]

customization.registerThemewrite · write

Adds or replaces one named theme in the registry without applying it.

Contract	Value
Controller	customization
Target scopes	chart
Family	customization
Implementation	sdk
Permission label	customization.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · customization.registerTheme.customizationPaths authority extractor · required when constrained
Revision domains	settings
Options index	None

Public SDK signature

(name: string, theme: ChartThemeName | ChartTheme) => Promise<void> | void

customization.setBuiltInIndicatorDefaultswrite · write

Strict catalog-backed defaults for future built-in indicators by exact native built-in indicator id.

Contract	Value
Controller	customization
Target scopes	chart
Family	customization
Implementation	sdk
Permission label	customization.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · customization.setBuiltInIndicatorDefaults.customizationPaths authority extractor · required when constrained resourceKinds · string · customization.setBuiltInIndicatorDefaults.resourceKinds authority extractor · required when constrained
Revision domains	settings
Options index	None

Public SDK signature

(indicatorId: string, defaults: IndicatorDefaultSettings) => Promise<void> | void

customization.setCandleColorswrite · write

Sets the candle up/down/no-change body, border, and wick colors.

Contract	Value
Controller	customization
Target scopes	chart
Family	customization
Implementation	sdk
Permission label	customization.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · customization.setCandleColors.customizationPaths authority extractor · required when constrained
Revision domains	settings
Options index	None

Public SDK signature

(colors: CandleColorSettings) => Promise<void> | void

customization.setContextMenuwrite · write

Replaces the context-menu customization settings.

Contract	Value
Controller	customization
Target scopes	chart
Family	customization
Implementation	sdk
Permission label	customization.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · customization.setContextMenu.customizationPaths authority extractor · required when constrained
Revision domains	settings
Options index	None

Public SDK signature

(settings: ContextMenuCustomization) => Promise<void> | void

customization.setDrawingDefaultStyleswrite · write

Sets default styles applied to future drawings created with the exact drawing tool id toolId.

Contract	Value
Controller	customization
Target scopes	chart
Family	customization
Implementation	sdk
Permission label	customization.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · customization.setDrawingDefaultStyles.customizationPaths authority extractor · required when constrained drawingKinds · string · customization.setDrawingDefaultStyles.drawingKinds authority extractor · required when constrained resourceKinds · string · customization.setDrawingDefaultStyles.resourceKinds authority extractor · required when constrained
Revision domains	settings
Options index	None

Public SDK signature

(toolId: string, styles: DrawingDefaultStyleSettings) => Promise<void> | void

customization.setIndicatorDefaultswrite · write

Sets default inputs/styles/placement applied to future indicators with the exact indicator name
indicatorName.

Contract	Value
Controller	customization
Target scopes	chart
Family	customization
Implementation	sdk
Permission label	customization.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · customization.setIndicatorDefaults.customizationPaths authority extractor · required when constrained resourceKinds · string · customization.setIndicatorDefaults.resourceKinds authority extractor · required when constrained
Revision domains	settings
Options index	None

Public SDK signature

(indicatorName: string, defaults: IndicatorDefaultSettings) => Promise<void> | void

customization.setLegendwrite · write

Replaces the legend display settings.

Contract	Value
Controller	customization
Target scopes	chart
Family	customization
Implementation	sdk
Permission label	customization.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · customization.setLegend.customizationPaths authority extractor · required when constrained symbols · string · customization.setLegend.symbols authority extractor · required when constrained
Revision domains	settings
Options index	None

Public SDK signature

(settings: LegendSettings) => Promise<void> | void

customization.setLocalewrite · write

Sets only the active locale identifier without replacing the rest of the localization settings.

Contract	Value
Controller	customization
Target scopes	chart
Family	customization
Implementation	sdk
Permission label	customization.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · customization.setLocale.customizationPaths authority extractor · required when constrained
Revision domains	settings
Options index	None

Public SDK signature

(locale: string) => Promise<void> | void

customization.setLocalizationwrite · write

Replaces the localization settings (locale, translations, and formatting).

Contract	Value
Controller	customization
Target scopes	chart
Family	customization
Implementation	sdk
Permission label	customization.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · customization.setLocalization.customizationPaths authority extractor · required when constrained
Revision domains	settings
Options index	None

Public SDK signature

(settings: LocalizationSettings) => Promise<void> | void

customization.setShortcutswrite · write

Replaces the keyboard-shortcut settings.

Contract	Value
Controller	customization
Target scopes	chart
Family	customization
Implementation	sdk
Permission label	customization.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · customization.setShortcuts.customizationPaths authority extractor · required when constrained
Revision domains	settings
Options index	None

Public SDK signature

(settings: ShortcutSettings) => Promise<void> | void

customization.setThemewrite · write

Applies a theme, either a built-in ChartThemeName or a full ChartTheme object; may complete
asynchronously.

Contract	Value
Controller	customization
Target scopes	chart
Family	customization
Implementation	sdk
Permission label	customization.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · customization.setTheme.customizationPaths authority extractor · required when constrained
Revision domains	settings
Options index	None

Public SDK signature

(theme: ChartThemeName | ChartTheme) => Promise<void> | void

customization.setThemeRegistrywrite · write

Replaces the whole named-theme registry that applyTheme resolves names against.

Contract	Value
Controller	customization
Target scopes	chart
Family	customization
Implementation	sdk
Permission label	customization.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · customization.setThemeRegistry.customizationPaths authority extractor · optional when constrained
Revision domains	settings
Options index	None

Public SDK signature

(registry: ChartThemeRegistry) => Promise<void> | void

customization.setTimezonewrite · write

Sets the timezone identifier used for time display on the chart.

Contract	Value
Controller	customization
Target scopes	chart
Family	customization
Implementation	sdk
Permission label	customization.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · customization.setTimezone.customizationPaths authority extractor · required when constrained
Revision domains	settings
Options index	None

Public SDK signature

(timezone: string) => Promise<void> | void

customization.setToolbarwrite · write

Replaces the chart toolbar customization settings.

Contract	Value
Controller	customization
Target scopes	chart
Family	customization
Implementation	sdk
Permission label	customization.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · customization.setToolbar.customizationPaths authority extractor · required when constrained
Revision domains	settings
Options index	None

Public SDK signature

(settings: ToolbarCustomization) => Promise<void> | void

customization.setTooltipFormattingwrite · write

Replaces the tooltip value-formatting settings.

Contract	Value
Controller	customization
Target scopes	chart
Family	customization
Implementation	sdk
Permission label	customization.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · customization.setTooltipFormatting.customizationPaths authority extractor · required when constrained
Revision domains	settings
Options index	None

Public SDK signature

(settings: TooltipFormattingSettings) => Promise<void> | void

customization.setWatermarkwrite · write

Sets the chart watermark from the supplied WatermarkSettings.

Contract	Value
Controller	customization
Target scopes	chart
Family	customization
Implementation	sdk
Permission label	customization.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · customization.setWatermark.customizationPaths authority extractor · required when constrained
Revision domains	settings
Options index	None

Public SDK signature

(watermark: WatermarkSettings) => Promise<void> | void

customization.unregisterThemewrite · write

Removes the theme registered under name from the registry.

Contract	Value
Controller	customization
Target scopes	chart
Family	customization
Implementation	sdk
Permission label	customization.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · customization.unregisterTheme.customizationPaths authority extractor · required when constrained
Revision domains	settings
Options index	None

Public SDK signature

(name: string) => Promise<void> | void

data.createWatchlistwrite · write

Creates a watchlist from the request and resolves the stored Watchlist.

Contract	Value
Controller	data
Target scopes	session, chart
Family	watchlists
Implementation	sdk
Permission label	marketdata.write
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · watchlists catalog literal · required when constrained symbols · string · data.createWatchlist.symbols authority extractor · required when constrained resourceIds · string · data.createWatchlist.resourceIds authority extractor · required when constrained resourceKinds · string · data.createWatchlist.resourceKinds authority extractor · required when constrained data.createWatchlist.dataProjection result filter · dataFields, maxRows data.createWatchlist.allowedSymbols result filter · symbols
Revision domains	watchlist
Options index	None

Public SDK signature

(request: WatchlistCreateRequest) => Promise<Watchlist>

data.deleteWatchlistwrite · write

Deletes the watchlist identified by the request.

Contract	Value
Controller	data
Target scopes	session, chart
Family	watchlists
Implementation	sdk
Permission label	marketdata.write
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · watchlists catalog literal · required when constrained resourceIds · string · data.deleteWatchlist.resourceIds authority extractor · required when constrained resourceKinds · string · data.deleteWatchlist.resourceKinds authority extractor · required when constrained
Revision domains	watchlist
Options index	None

Public SDK signature

(request: WatchlistDeleteRequest) => Promise<void>

data.getBookHistoryread · read

Loads historical order-book data for the requested range.

Contract	Value
Controller	data
Target scopes	session, chart
Family	marketData
Implementation	sdk
Permission label	marketdata.read
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · l2 catalog literal · required when constrained maxRows · finite-number · args[0].limit · required when constrained; signed value maxHistoryLookbackMs · finite-number · data.getBookHistory.maxHistoryLookbackMs.sourceUnavailable authority extractor · required when constrained; signed value symbols · string · data.getBookHistory.symbols authority extractor · required when constrained data.getBookHistory.dataProjection result filter · dataFields, maxRows, maxHistoryLookbackMs, maxMarketDataAgeMs data.getBookHistory.allowedSymbols result filter · symbols
Revision domains	None
Options index	None

Public SDK signature

(request: BookHistoryRequest) => Promise<BookHistoryResult>

data.getCapabilitiesread · read

Resolves the feed's declared configuration (MarketDataFeedConfig), cached from its onReady
declaration.

Contract	Value
Controller	data
Target scopes	session, chart
Family	marketData
Implementation	sdk
Permission label	marketdata.read
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	None
Options index	None

Public SDK signature

() => Promise<MarketDataFeedConfig>

data.getDataWindowread · read

Loads a DataWindowSnapshot of values for the request.

Contract	Value
Controller	data
Target scopes	session, chart
Family	marketData
Implementation	sdk
Permission label	marketdata.read
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · bars catalog literal · required when constrained symbols · string · data.getDataWindow.symbols authority extractor · required when constrained data.getDataWindow.dataProjection result filter · dataFields, maxRows, maxMarketDataAgeMs data.getDataWindow.allowedSymbols result filter · symbols
Revision domains	None
Options index	None

Public SDK signature

(request: DataWindowRequest) => Promise<DataWindowSnapshot>

data.getDepthread · read

Loads an order-book depth snapshot for the requested symbol.

Contract	Value
Controller	data
Target scopes	session, chart
Family	marketData
Implementation	sdk
Permission label	marketdata.read
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · l2 catalog literal · required when constrained maxRows · finite-number · args[0].levels · required when constrained; signed value symbols · string · data.getDepth.symbols authority extractor · required when constrained data.getDepth.dataProjection result filter · dataFields, maxRows, maxMarketDataAgeMs data.getDepth.allowedSymbols result filter · symbols
Revision domains	None
Options index	None

Public SDK signature

(request: DepthRequest) => Promise<SdkMarketDepth>

data.getEventsread · read

Loads one page of market events matching the request.

Contract	Value
Controller	data
Target scopes	session, chart
Family	marketData
Implementation	sdk
Permission label	marketdata.read
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · events catalog literal · required when constrained maxHistoryLookbackMs · finite-number · args[0].endTime - args[0].startTime · required when constrained; absolute magnitude maxRows · finite-number · args[0].limit · required when constrained; signed value symbols · string · data.getEvents.symbols authority extractor · required when constrained resourceIds · string · data.getEvents.resourceIds authority extractor · required when constrained resourceKinds · string · data.getEvents.resourceKinds authority extractor · required when constrained data.getEvents.dataProjection result filter · dataFields, maxRows, maxHistoryLookbackMs data.getEvents.allowedSymbols result filter · symbols data.getEvents.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

(request: GetEventsRequest) => Promise<MarketEventPage>

data.getExternalSeriesread · read

Loads an auxiliary external data series described by the request.

Contract	Value
Controller	data
Target scopes	session, chart
Family	marketData
Implementation	sdk
Permission label	marketdata.read
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · external-series catalog literal · required when constrained maxHistoryLookbackMs · finite-number · args[0].endTime - args[0].startTime · required when constrained; absolute magnitude maxRows · finite-number · args[0].limit · required when constrained; signed value symbols · string · data.getExternalSeries.symbols authority extractor · required when constrained data.getExternalSeries.dataProjection result filter · dataFields, maxRows, maxHistoryLookbackMs data.getExternalSeries.allowedSymbols result filter · symbols
Revision domains	None
Options index	None

Public SDK signature

(request: ExternalSeriesRequest) => Promise<ExternalSeriesResult>

data.getInstrumentDetailsread · read

Loads the instrument reference profile (InstrumentDetails) for a resolved symbol.

Contract	Value
Controller	data
Target scopes	session, chart
Family	marketData
Implementation	sdk
Permission label	marketdata.read
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · instrument-details catalog literal · required when constrained symbols · string · data.getInstrumentDetails.symbols authority extractor · required when constrained data.getInstrumentDetails.dataProjection result filter · dataFields data.getInstrumentDetails.allowedSymbols result filter · symbols
Revision domains	None
Options index	None

Public SDK signature

(request: InstrumentDetailsRequest) => Promise<InstrumentDetails>

data.getMarksread · read

Loads bar marks (TimeMarks) rendered on individual bars for the requested symbol and range.

Contract	Value
Controller	data
Target scopes	session, chart
Family	marketData
Implementation	sdk
Permission label	marketdata.read
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · marks catalog literal · required when constrained maxHistoryLookbackMs · finite-number · args[0].endTime - args[0].startTime · required when constrained; absolute magnitude symbols · string · data.getMarks.symbols authority extractor · required when constrained resourceIds · string · data.getMarks.resourceIds authority extractor · required when constrained resourceKinds · string · data.getMarks.resourceKinds authority extractor · required when constrained data.getMarks.dataProjection result filter · dataFields, maxRows, maxHistoryLookbackMs data.getMarks.allowedSymbols result filter · symbols data.getMarks.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

(request: MarksRequest) => Promise<TimeMark[]>

data.getNewsread · read

Loads news items matching the request.

Contract	Value
Controller	data
Target scopes	session, chart
Family	marketData
Implementation	sdk
Permission label	marketdata.read
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · news catalog literal · required when constrained maxHistoryLookbackMs · finite-number · args[0].endTime - args[0].startTime · required when constrained; absolute magnitude maxRows · finite-number · args[0].limit · required when constrained; signed value symbols · string · data.getNews.symbols authority extractor · optional when constrained resourceIds · string · data.getNews.resourceIds authority extractor · required when constrained resourceKinds · string · data.getNews.resourceKinds authority extractor · required when constrained data.getNews.dataProjection result filter · dataFields, maxRows, maxHistoryLookbackMs data.getNews.allowedSymbols result filter · symbols data.getNews.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

(request: NewsRequest) => Promise<NewsItem[]>

data.getOperationSupportread · read

Exact async support authority derived from the feed's declaration and callable methods.

Contract	Value
Controller	data
Target scopes	session, chart
Family	marketData
Implementation	sdk
Permission label	marketdata.read
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	None
Options index	None

Public SDK signature

() => Promise<MarketDataControllerOperationSupport>

data.getOptionContractsread · read

Loads the option-contract series snapshot for the request.

Contract	Value
Controller	data
Target scopes	session, chart
Family	marketData
Implementation	sdk
Permission label	marketdata.read
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · options catalog literal · required when constrained symbols · string · data.getOptionContracts.symbols authority extractor · required when constrained resourceKinds · string · data.getOptionContracts.resourceKinds authority extractor · required when constrained data.getOptionContracts.dataProjection result filter · dataFields, maxRows, maxMarketDataAgeMs data.getOptionContracts.allowedSymbols result filter · symbols data.getOptionContracts.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

(request: OptionContractsRequest) => Promise<OptionSeriesSnapshot>

data.getOptionQuotesread · read

Loads option quote data as an OptionSeriesSnapshot for the request.

Contract	Value
Controller	data
Target scopes	session, chart
Family	marketData
Implementation	sdk
Permission label	marketdata.read
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · options catalog literal · required when constrained symbols · string · data.getOptionQuotes.symbols authority extractor · required when constrained resourceKinds · string · data.getOptionQuotes.resourceKinds authority extractor · required when constrained data.getOptionQuotes.dataProjection result filter · dataFields, maxRows, maxMarketDataAgeMs data.getOptionQuotes.allowedSymbols result filter · symbols data.getOptionQuotes.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

(request: OptionQuotesRequest) => Promise<OptionSeriesSnapshot>

data.getQuotesread · read

Loads current quote snapshots for the requested symbols.

Contract	Value
Controller	data
Target scopes	session, chart
Family	marketData
Implementation	sdk
Permission label	marketdata.read
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · l1 catalog literal · required when constrained maxRows · finite-number · args[0].symbols.length · required when constrained; signed value symbols · string · data.getQuotes.symbols authority extractor · required when constrained data.getQuotes.dataProjection result filter · dataFields, maxRows, maxMarketDataAgeMs data.getQuotes.allowedSymbols result filter · symbols
Revision domains	None
Options index	None

Public SDK signature

(request: QuoteRequest) => Promise<Quote[]>

data.getServerTimeread · read

Resolves the provider's current server time as a Unix timestamp.

Contract	Value
Controller	data
Target scopes	session, chart
Family	marketData
Implementation	sdk
Permission label	marketdata.read
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · server-time catalog literal · required when constrained
Revision domains	None
Options index	None

Public SDK signature

() => Promise<number>

data.getTimeAndSalesread · read

Loads a time-and-sales (tape) snapshot for the request.

Contract	Value
Controller	data
Target scopes	session, chart
Family	marketData
Implementation	sdk
Permission label	marketdata.read
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · tape catalog literal · required when constrained maxHistoryLookbackMs · finite-number · args[0].endTime - args[0].startTime · required when constrained; absolute magnitude maxRows · finite-number · args[0].limit · required when constrained; signed value symbols · string · data.getTimeAndSales.symbols authority extractor · required when constrained data.getTimeAndSales.dataProjection result filter · dataFields, maxRows, maxHistoryLookbackMs, maxMarketDataAgeMs data.getTimeAndSales.allowedSymbols result filter · symbols
Revision domains	None
Options index	None

Public SDK signature

(request: TimeAndSalesRequest) => Promise<TimeAndSalesEntry[]>

data.getTimescaleMarksread · read

Loads marks rendered on the time scale for the requested symbol and range.

Contract	Value
Controller	data
Target scopes	session, chart
Family	marketData
Implementation	sdk
Permission label	marketdata.read
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · marks catalog literal · required when constrained maxHistoryLookbackMs · finite-number · args[0].endTime - args[0].startTime · required when constrained; absolute magnitude symbols · string · data.getTimescaleMarks.symbols authority extractor · required when constrained resourceIds · string · data.getTimescaleMarks.resourceIds authority extractor · required when constrained resourceKinds · string · data.getTimescaleMarks.resourceKinds authority extractor · required when constrained data.getTimescaleMarks.dataProjection result filter · dataFields, maxRows, maxHistoryLookbackMs data.getTimescaleMarks.allowedSymbols result filter · symbols data.getTimescaleMarks.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

(request: TimeScaleMarksRequest) => Promise<TimeScaleMark[]>

data.getVolumeProfileResolutionForPeriodread · read

Resolves the bar interval volume-profile calculations should request for the period described by
the request.

Contract	Value
Controller	data
Target scopes	session, chart
Family	marketData
Implementation	sdk
Permission label	marketdata.read
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · bars catalog literal · required when constrained maxHistoryLookbackMs · finite-number · args[0].endTime - args[0].startTime · required when constrained; absolute magnitude symbols · string · data.getVolumeProfileResolutionForPeriod.symbols authority extractor · required when constrained data.getVolumeProfileResolutionForPeriod.allowedSymbols result filter · symbols
Revision domains	None
Options index	None

Public SDK signature

(request: VolumeProfileIntervalRequest) => Promise<ChartInterval>

data.getWatchlistread · read

Loads one watchlist by id, or the active watchlist when the request is omitted.

Contract	Value
Controller	data
Target scopes	session, chart
Family	watchlist
Implementation	sdk
Permission label	marketdata.read
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · watchlists catalog literal · required when constrained resourceIds · string · data.getWatchlist.resourceIds authority extractor · required when constrained resourceKinds · string · data.getWatchlist.resourceKinds authority extractor · required when constrained data.getWatchlist.dataProjection result filter · dataFields, maxRows data.getWatchlist.allowedSymbols result filter · symbols data.getWatchlist.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

(request?: WatchlistRequest) => Promise<Watchlist>

data.listWatchlistsread · read

Lists summaries of all watchlists available from the feed.

Contract	Value
Controller	data
Target scopes	session, chart
Family	watchlist
Implementation	sdk
Permission label	marketdata.read
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · watchlists catalog literal · required when constrained data.listWatchlists.dataProjection result filter · dataFields, maxRows data.listWatchlists.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

() => Promise<WatchlistSummary[]>

data.readBarsread · read

Read an exact history window without mutating any mounted chart.

Contract	Value
Controller	data
Target scopes	session, chart
Family	marketData
Implementation	sdk
Permission label	marketdata.read
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · bars catalog literal · required when constrained maxHistoryLookbackMs · finite-number · args[2].endTime - args[2].startTime · required when constrained; absolute magnitude maxRows · finite-number · args[2].barCount · required when constrained; signed value symbols · string · data.readBars.symbols authority extractor · required when constrained data.readBars.dataProjection result filter · dataFields, maxRows, maxHistoryLookbackMs, maxMarketDataAgeMs data.readBars.allowedSymbols result filter · symbols
Revision domains	None
Options index	None

Public SDK signature

(symbol: SdkSymbolInfo, interval: ChartInterval, request: BarHistoryRequest) => Promise<BarHistoryResult>

data.renameWatchlistwrite · write

Renames a watchlist and resolves the updated Watchlist.

Contract	Value
Controller	data
Target scopes	session, chart
Family	watchlists
Implementation	sdk
Permission label	marketdata.write
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · watchlists catalog literal · required when constrained resourceIds · string · data.renameWatchlist.resourceIds authority extractor · required when constrained resourceKinds · string · data.renameWatchlist.resourceKinds authority extractor · required when constrained data.renameWatchlist.dataProjection result filter · dataFields, maxRows data.renameWatchlist.allowedSymbols result filter · symbols
Revision domains	watchlist
Options index	None

Public SDK signature

(request: WatchlistRenameRequest) => Promise<Watchlist>

data.resetCachewrite · write

Clears feed-side history caches so subsequent loads refetch from the underlying source.

Contract	Value
Controller	data
Target scopes	session, chart
Family	marketData
Implementation	sdk
Permission label	marketdata.write
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	data
Options index	None

Public SDK signature

(options?: CacheResetOptions) => Promise<void>

data.resolveSessionCalendarread · read

Resolves the session aggregation calendar used for session-aligned bar aggregation, or
null/undefined when none applies.

Contract	Value
Controller	data
Target scopes	session, chart
Family	marketData
Implementation	sdk
Permission label	marketdata.read
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · sessions catalog literal · required when constrained maxHistoryLookbackMs · finite-number · args[0].endTime - args[0].startTime · required when constrained; absolute magnitude symbols · string · data.resolveSessionCalendar.symbols authority extractor · required when constrained data.resolveSessionCalendar.dataProjection result filter · dataFields, maxRows, maxHistoryLookbackMs data.resolveSessionCalendar.allowedSymbols result filter · symbols
Revision domains	None
Options index	None

Public SDK signature

(request: SessionAggregationCalendarRequest) => Promise<SessionAggregationCalendar | null | undefined>

data.resolveSessionInforead · read

Resolves trading-session information for the requested symbol.

Contract	Value
Controller	data
Target scopes	session, chart
Family	marketData
Implementation	sdk
Permission label	marketdata.read
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · sessions catalog literal · required when constrained symbols · string · data.resolveSessionInfo.symbols authority extractor · required when constrained data.resolveSessionInfo.dataProjection result filter · dataFields, maxRows, maxMarketDataAgeMs data.resolveSessionInfo.allowedSymbols result filter · symbols
Revision domains	None
Options index	None

Public SDK signature

(request: SessionInfoRequest) => Promise<SessionInfo>

data.resolveSymbolread · read

Resolves a symbol selection — a ticker string or the exact descriptor a search row carried —
into a full SdkSymbolInfo, optionally re-resolved for session, currency, or unit context.

Contract	Value
Controller	data
Target scopes	session, chart
Family	marketData
Implementation	sdk
Permission label	marketdata.read
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · instrument-details catalog literal · required when constrained symbols · string · data.resolveSymbol.symbols authority extractor · required when constrained data.resolveSymbol.dataProjection result filter · dataFields data.resolveSymbol.allowedSymbols result filter · symbols
Revision domains	None
Options index	None

Public SDK signature

(symbol: SymbolSelection, context?: SymbolResolveContext) => Promise<SdkSymbolInfo>

data.searchSymbolsread · read

Searches the feed's symbol directory and resolves the matching SymbolSearchResults.

Contract	Value
Controller	data
Target scopes	session, chart
Family	marketData
Implementation	sdk
Permission label	marketdata.read
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · search catalog literal · required when constrained maxRows · finite-number · args[0].limit · required when constrained; signed value data.searchSymbols.dataProjection result filter · dataFields, maxRows data.searchSymbols.allowedSymbols result filter · symbols
Revision domains	None
Options index	None

Public SDK signature

(request: SymbolSearchRequest) => Promise<SymbolSearchResult[]>

data.setActiveWatchlistwrite · write

Marks a watchlist as the active one and resolves it.

Contract	Value
Controller	data
Target scopes	session, chart
Family	watchlists
Implementation	sdk
Permission label	marketdata.write
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · watchlists catalog literal · required when constrained resourceIds · string · data.setActiveWatchlist.resourceIds authority extractor · required when constrained resourceKinds · string · data.setActiveWatchlist.resourceKinds authority extractor · required when constrained data.setActiveWatchlist.dataProjection result filter · dataFields, maxRows data.setActiveWatchlist.allowedSymbols result filter · symbols
Revision domains	watchlist
Options index	None

Public SDK signature

(request: WatchlistSetActiveRequest) => Promise<Watchlist>

data.updateWatchlistwrite · write

Updates a watchlist's contents and resolves the updated Watchlist.

Contract	Value
Controller	data
Target scopes	session, chart
Family	watchlists
Implementation	sdk
Permission label	marketdata.write
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · watchlists catalog literal · required when constrained symbols · string · data.updateWatchlist.symbols authority extractor · required when constrained resourceIds · string · data.updateWatchlist.resourceIds authority extractor · required when constrained resourceKinds · string · data.updateWatchlist.resourceKinds authority extractor · required when constrained data.updateWatchlist.dataProjection result filter · dataFields, maxRows data.updateWatchlist.allowedSymbols result filter · symbols
Revision domains	watchlist
Options index	None

Public SDK signature

(request: WatchlistUpdateRequest) => Promise<Watchlist>

depthLadder.cancelAlltrade · financial

DepthLadderControllerApi.cancelAll

Contract	Value
Controller	depthLadder
Target scopes	widget
Family	emergency
Implementation	sdk
Permission label	trading.write
Financial risk classes	emergency-risk-reducing
Decision receipt	never
Input constraints	symbols · string · depthLadder.current.symbols authority extractor · required when constrained accounts · string · depthLadder.current.accounts authority extractor · required when constrained resourceIds · string · depthLadder.cancelAll.resourceIds authority extractor · required when constrained resourceKinds · string · depthLadder.cancelAll.resourceKinds authority extractor · required when constrained depthLadder.cancelAll.allowedSymbolsAccounts result filter · symbols, accounts
Revision domains	depthLadder
Options index	0

Public SDK signature

cancelAll(options?: DepthLadderMutationOptions): Promise<DepthLadderActionOutcome>

depthLadder.clearMessagewrite · write

DepthLadderControllerApi.clearMessage

Contract	Value
Controller	depthLadder
Target scopes	widget
Family	depthLadder
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · depthLadder.current.symbols authority extractor · required when constrained accounts · string · depthLadder.current.accounts authority extractor · required when constrained
Revision domains	depthLadder
Options index	None

Public SDK signature

clearMessage(options?: DepthLadderMutationOptions): boolean

depthLadder.flattentrade · financial

DepthLadderControllerApi.flatten

Contract	Value
Controller	depthLadder
Target scopes	widget
Family	emergency
Implementation	sdk
Permission label	trading.write
Financial risk classes	emergency-risk-reducing
Decision receipt	never
Input constraints	symbols · string · depthLadder.current.symbols authority extractor · required when constrained accounts · string · depthLadder.current.accounts authority extractor · required when constrained resourceIds · string · depthLadder.flatten.resourceIds authority extractor · required when constrained resourceKinds · string · depthLadder.flatten.resourceKinds authority extractor · required when constrained depthLadder.flatten.allowedSymbolsAccounts result filter · symbols, accounts
Revision domains	depthLadder
Options index	0

Public SDK signature

flatten(options?: DepthLadderMutationOptions): Promise<DepthLadderActionOutcome>

depthLadder.getSnapshotread · read

DepthLadderControllerApi.getSnapshot

Contract	Value
Controller	depthLadder
Target scopes	widget
Family	orderFlow
Implementation	sdk
Permission label	trading.read
Financial risk classes	None
Decision receipt	None
Input constraints	depthLadder.getSnapshot.allowedSymbolsAccounts result filter · symbols, accounts depthLadder.getSnapshot.allowedResources result filter · resourceIds, resourceKinds depthLadder.getSnapshot.tradePolicy result filter · orderTypes, orderSides, timeInForce, maxQuantity
Revision domains	None
Options index	None

Public SDK signature

getSnapshot(): DepthLadderSnapshot

depthLadder.isReadyread · read

DepthLadderControllerApi.isReady

Contract	Value
Controller	depthLadder
Target scopes	widget
Family	orderFlow
Implementation	sdk
Permission label	trading.read
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	None
Options index	None

Public SDK signature

isReady(): boolean

depthLadder.placeAtLeveltrade · financial

DepthLadderControllerApi.placeAtLevel

Contract	Value
Controller	depthLadder
Target scopes	widget
Family	orders
Implementation	sdk
Permission label	trading.write
Financial risk classes	risk-increasing
Decision receipt	always
Input constraints	symbols · string · depthLadder.current.symbols authority extractor · required when constrained accounts · string · depthLadder.current.accounts authority extractor · required when constrained resourceIds · string · depthLadder.placeAtLevel.resourceIds authority extractor · required when constrained resourceKinds · string · depthLadder.placeAtLevel.resourceKinds authority extractor · required when constrained orderSides · string · args[0] · required when constrained depthLadder.placeAtLevel.allowedSymbolsAccounts result filter · symbols, accounts
Revision domains	depthLadder
Options index	2

Public SDK signature

placeAtLevel(
    side: DepthLadderOrderSide,
    price: number,
    options?: DepthLadderMutationOptions,
  ): Promise<DepthLadderActionOutcome>

depthLadder.placeMarkettrade · financial

DepthLadderControllerApi.placeMarket

Contract	Value
Controller	depthLadder
Target scopes	widget
Family	orders
Implementation	sdk
Permission label	trading.write
Financial risk classes	risk-increasing
Decision receipt	always
Input constraints	symbols · string · depthLadder.current.symbols authority extractor · required when constrained accounts · string · depthLadder.current.accounts authority extractor · required when constrained resourceIds · string · depthLadder.placeMarket.resourceIds authority extractor · required when constrained resourceKinds · string · depthLadder.placeMarket.resourceKinds authority extractor · required when constrained orderSides · string · args[0] · required when constrained depthLadder.placeMarket.allowedSymbolsAccounts result filter · symbols, accounts
Revision domains	depthLadder
Options index	1

Public SDK signature

placeMarket(
    side: DepthLadderOrderSide,
    options?: DepthLadderMutationOptions,
  ): Promise<DepthLadderActionOutcome>

depthLadder.recenterPriceWindowwrite · write

DepthLadderControllerApi.recenterPriceWindow

Contract	Value
Controller	depthLadder
Target scopes	widget
Family	depthLadder
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · depthLadder.recenterPriceWindow.symbols authority extractor · required when constrained
Revision domains	depthLadder
Options index	None

Public SDK signature

recenterPriceWindow(
    centerPrice: number,
    centerSymbol?: string,
    options?: DepthLadderMutationOptions,
  ): boolean

depthLadder.replaceCustomFieldswrite · write

DepthLadderControllerApi.replaceCustomFields

Contract	Value
Controller	depthLadder
Target scopes	widget
Family	depthLadder
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · depthLadder.current.symbols authority extractor · required when constrained accounts · string · depthLadder.current.accounts authority extractor · required when constrained resourceIds · string · depthLadder.replaceCustomFields.resourceIds authority extractor · required when constrained resourceKinds · string · depthLadder.replaceCustomFields.resourceKinds authority extractor · required when constrained
Revision domains	depthLadder
Options index	None

Public SDK signature

replaceCustomFields(
    values: Readonly<Record<string, unknown>>,
    options?: DepthLadderMutationOptions,
  ): boolean

depthLadder.reversetrade · financial

DepthLadderControllerApi.reverse

Contract	Value
Controller	depthLadder
Target scopes	widget
Family	positions
Implementation	sdk
Permission label	trading.write
Financial risk classes	risk-changing
Decision receipt	always
Input constraints	symbols · string · depthLadder.current.symbols authority extractor · required when constrained accounts · string · depthLadder.current.accounts authority extractor · required when constrained resourceIds · string · depthLadder.reverse.resourceIds authority extractor · required when constrained resourceKinds · string · depthLadder.reverse.resourceKinds authority extractor · required when constrained depthLadder.reverse.allowedSymbolsAccounts result filter · symbols, accounts
Revision domains	depthLadder
Options index	0

Public SDK signature

reverse(options?: DepthLadderMutationOptions): Promise<DepthLadderActionOutcome>

depthLadder.setCustomFieldwrite · write

DepthLadderControllerApi.setCustomField

Contract	Value
Controller	depthLadder
Target scopes	widget
Family	depthLadder
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · depthLadder.current.symbols authority extractor · required when constrained accounts · string · depthLadder.current.accounts authority extractor · required when constrained resourceIds · string · depthLadder.setCustomField.resourceIds authority extractor · required when constrained resourceKinds · string · depthLadder.setCustomField.resourceKinds authority extractor · required when constrained
Revision domains	depthLadder
Options index	None

Public SDK signature

setCustomField(fieldId: string, value: unknown, options?: DepthLadderMutationOptions): boolean

depthLadder.setDurationwrite · write

DepthLadderControllerApi.setDuration

Contract	Value
Controller	depthLadder
Target scopes	widget
Family	depthLadder
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · depthLadder.current.symbols authority extractor · required when constrained accounts · string · depthLadder.current.accounts authority extractor · required when constrained timeInForce · string · depthLadder.setDuration.timeInForce.sourceUnavailable authority extractor · required when constrained
Revision domains	depthLadder
Options index	None

Public SDK signature

setDuration(durationKey: string | undefined, options?: DepthLadderMutationOptions): boolean

depthLadder.setDurationExpirywrite · write

DepthLadderControllerApi.setDurationExpiry

Contract	Value
Controller	depthLadder
Target scopes	widget
Family	depthLadder
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · depthLadder.current.symbols authority extractor · required when constrained accounts · string · depthLadder.current.accounts authority extractor · required when constrained
Revision domains	depthLadder
Options index	None

Public SDK signature

setDurationExpiry(
    expiry: { date?: string; time?: string },
    options?: DepthLadderMutationOptions,
  ): boolean

depthLadder.setPriceWindowwrite · write

DepthLadderControllerApi.setPriceWindow

Contract	Value
Controller	depthLadder
Target scopes	widget
Family	depthLadder
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · depthLadder.current.symbols authority extractor · required when constrained accounts · string · depthLadder.current.accounts authority extractor · required when constrained
Revision domains	depthLadder
Options index	None

Public SDK signature

setPriceWindow(priceWindow: DepthLadderPriceWindowInput, options?: DepthLadderMutationOptions): boolean

depthLadder.setQuantitywrite · write

DepthLadderControllerApi.setQuantity

Contract	Value
Controller	depthLadder
Target scopes	widget
Family	depthLadder
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · depthLadder.current.symbols authority extractor · required when constrained accounts · string · depthLadder.current.accounts authority extractor · required when constrained maxQuantity · finite-number · depthLadder.setQuantity.maxQuantity.sourceUnavailable authority extractor · required when constrained; absolute magnitude
Revision domains	depthLadder
Options index	None

Public SDK signature

setQuantity(quantity: string, options?: DepthLadderMutationOptions): boolean

marketDepth.clearSelectionwrite · write

MarketDepthControllerApi.clearSelection

Contract	Value
Controller	marketDepth
Target scopes	widget
Family	orderFlow
Implementation	sdk
Permission label	marketdata.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · marketDepth.current.symbols authority extractor · required when constrained
Revision domains	orderFlow
Options index	None

Public SDK signature

clearSelection(): boolean

marketDepth.getSnapshotread · read

MarketDepthControllerApi.getSnapshot

Contract	Value
Controller	marketDepth
Target scopes	widget
Family	orderFlow
Implementation	sdk
Permission label	marketdata.read
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · l2 catalog literal · required when constrained marketDepth.getSnapshot.dataProjection result filter · dataFields, maxRows, maxMarketDataAgeMs marketDepth.getSnapshot.allowedSymbols result filter · symbols
Revision domains	None
Options index	None

Public SDK signature

getSnapshot(): MarketDepthSnapshot

marketDepth.selectLevelwrite · write

MarketDepthControllerApi.selectLevel

Contract	Value
Controller	marketDepth
Target scopes	widget
Family	orderFlow
Implementation	sdk
Permission label	marketdata.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · marketDepth.current.symbols authority extractor · required when constrained marketDepth.selectLevel.allowedSymbols result filter · symbols
Revision domains	orderFlow
Options index	None

Public SDK signature

selectLevel(side: 'bid' | 'ask', level: DepthLevel): MarketDepthSelectedLevel

marketDepth.setLevelswrite · write

MarketDepthControllerApi.setLevels

Contract	Value
Controller	marketDepth
Target scopes	widget
Family	orderFlow
Implementation	sdk
Permission label	marketdata.write
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · l2 catalog literal · required when constrained maxRows · finite-number · args[0] · required when constrained; signed value symbols · string · marketDepth.current.symbols authority extractor · required when constrained
Revision domains	orderFlow
Options index	None

Public SDK signature

setLevels(levels: number): Promise<void>

marketDepth.setShowVenuewrite · write

MarketDepthControllerApi.setShowVenue

Contract	Value
Controller	marketDepth
Target scopes	widget
Family	orderFlow
Implementation	sdk
Permission label	marketdata.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · marketDepth.current.symbols authority extractor · required when constrained
Revision domains	orderFlow
Options index	None

Public SDK signature

setShowVenue(showVenue: boolean): boolean

marketDepth.setSymbolwrite · write

MarketDepthControllerApi.setSymbol

Contract	Value
Controller	marketDepth
Target scopes	widget
Family	orderFlow
Implementation	sdk
Permission label	marketdata.write
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · l2 catalog literal · required when constrained symbols · string · marketDepth.setSymbol.symbols authority extractor · required when constrained
Revision domains	orderFlow
Options index	None

Public SDK signature

setSymbol(symbol: SdkSymbolInfo | undefined): Promise<void>

marketEvents.addwrite · write

Adds one host-owned event after validating it against its registered type; returns the stored
event id and throws when the sourceId/id identity already exists.

Contract	Value
Controller	marketEvents
Target scopes	chart
Family	chartSettings
Implementation	sdk
Permission label	events.control
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · events catalog literal · required when constrained symbols · string · marketEvents.add.symbols authority extractor · required when constrained resourceIds · string · marketEvents.add.resourceIds authority extractor · required when constrained resourceKinds · string · marketEvents.add.resourceKinds authority extractor · required when constrained
Revision domains	marketEvents
Options index	None

Public SDK signature

(event: MarketEvent) => string

marketEvents.clearwrite · write

Removes the host-owned events matching the filter (provider-owned events are skipped) and emits
a clear change.

Contract	Value
Controller	marketEvents
Target scopes	chart
Family	chartSettings
Implementation	sdk
Permission label	events.control
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · events catalog literal · required when constrained resourceIds · string · marketEvents.clear.resourceIds authority extractor · required when constrained resourceKinds · string · marketEvents.clear.resourceKinds authority extractor · required when constrained
Revision domains	marketEvents
Options index	None

Public SDK signature

(filter?: MarketEventFilter) => void

marketEvents.closeCenterwrite · write

Closes the events-center panel; a no-op when already closed.

Contract	Value
Controller	marketEvents
Target scopes	chart
Family	chartSettings
Implementation	sdk
Permission label	events.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	ui
Options index	None

Public SDK signature

() => void

marketEvents.getread · read

Returns the current events matching an optional source/type/time filter, sorted by time, then
source id, then event id.

Contract	Value
Controller	marketEvents
Target scopes	chart
Family	marketData
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · events catalog literal · required when constrained resourceIds · string · marketEvents.get.resourceIds authority extractor · required when constrained resourceKinds · string · marketEvents.get.resourceKinds authority extractor · required when constrained marketEvents.get.dataProjection result filter · dataFields, maxRows, maxHistoryLookbackMs marketEvents.get.allowedSymbols result filter · symbols marketEvents.get.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

(filter?: MarketEventFilter) => MarketEvent[]

marketEvents.getCatalogread · read

Returns the merged event-type catalog built from built-in, provider, and host-registered
descriptors, sorted by group order, then type order, then label.

Contract	Value
Controller	marketEvents
Target scopes	chart
Family	marketData
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	marketEvents.getCatalog.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

() => MarketEventCatalog

marketEvents.isCenterOpenread · read

Returns whether the events-center panel is currently open.

Contract	Value
Controller	marketEvents
Target scopes	chart
Family	marketData
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	None
Options index	None

Public SDK signature

() => boolean

marketEvents.openCenterwrite · write

Opens the events-center panel; a no-op when already open.

Contract	Value
Controller	marketEvents
Target scopes	chart
Family	chartSettings
Implementation	sdk
Permission label	events.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	ui
Options index	None

Public SDK signature

() => void

marketEvents.refreshwrite · write

Refetches events from all (or the named) providers, replacing each provider's events and
restarting its live subscription; per-provider failures surface as market-event-provider-error
instead of rejecting.

Contract	Value
Controller	marketEvents
Target scopes	chart
Family	chartSettings
Implementation	sdk
Permission label	events.control
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · events catalog literal · required when constrained maxHistoryLookbackMs · finite-number · args[0].endTime - args[0].startTime · required when constrained; absolute magnitude maxRows · finite-number · args[0].limit · required when constrained; signed value resourceIds · string · marketEvents.refresh.resourceConstraintUnavailable authority extractor · required when constrained resourceKinds · string · marketEvents.refresh.resourceConstraintUnavailable authority extractor · required when constrained
Revision domains	marketEvents
Options index	None

Public SDK signature

(options?: MarketEventsRefreshOptions) => Promise<void>

marketEvents.registerTypewrite · write

Registers a host-defined custom event-type descriptor; returns an unsubscribe handle that
removes it.

Contract	Value
Controller	marketEvents
Target scopes	chart
Family	chartSettings
Implementation	sdk
Permission label	events.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceKinds · string · marketEvents.registerType.resourceKinds authority extractor · required when constrained
Revision domains	marketEvents
Options index	None

Public SDK signature

(descriptor: MarketEventTypeDescriptor) => Unsubscribe

marketEvents.removewrite · write

Removes one host-owned event; throws for provider-owned events and is a no-op for unknown
identities.

Contract	Value
Controller	marketEvents
Target scopes	chart
Family	chartSettings
Implementation	sdk
Permission label	events.control
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · events catalog literal · required when constrained resourceIds · string · marketEvents.remove.resourceIds authority extractor · required when constrained resourceKinds · string · marketEvents.remove.resourceKinds authority extractor · required when constrained
Revision domains	marketEvents
Options index	None

Public SDK signature

(sourceId: string, eventId: string) => void

marketEvents.setwrite · write

Replaces the host-owned event set — all of it, or one source's events when options.sourceId is
given — with the validated batch.

Contract	Value
Controller	marketEvents
Target scopes	chart
Family	chartSettings
Implementation	sdk
Permission label	events.control
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · events catalog literal · required when constrained symbols · string · marketEvents.set.symbols authority extractor · required when constrained resourceIds · string · marketEvents.set.resourceIds authority extractor · required when constrained resourceKinds · string · marketEvents.set.resourceKinds authority extractor · required when constrained
Revision domains	marketEvents
Options index	None

Public SDK signature

(events: MarketEvent[], options?: { sourceId?: string }) => void

marketEvents.unregisterTypewrite · write

Removes a registered custom event type by id, dropping its events from the set.

Contract	Value
Controller	marketEvents
Target scopes	chart
Family	chartSettings
Implementation	sdk
Permission label	events.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceKinds · string · marketEvents.unregisterType.resourceKinds authority extractor · required when constrained
Revision domains	marketEvents
Options index	None

Public SDK signature

(typeId: MarketEventType) => void

marketEvents.updatewrite · write

Patches an existing host-owned event and revalidates the merged result; identity fields (id,
sourceId, type) cannot change and provider-owned events are rejected.

Contract	Value
Controller	marketEvents
Target scopes	chart
Family	chartSettings
Implementation	sdk
Permission label	events.control
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · events catalog literal · required when constrained symbols · string · marketEvents.update.symbols authority extractor · required when constrained resourceIds · string · marketEvents.update.resourceIds authority extractor · required when constrained resourceKinds · string · marketEvents.update.resourceKinds authority extractor · required when constrained
Revision domains	marketEvents
Options index	None

Public SDK signature

(sourceId: string, eventId: string, patch: Partial<Omit<MarketEvent, 'id' | 'sourceId' | 'type'>>) => void

news.refreshwrite · write

Emits a news-refresh-requested event carrying the chart's current symbol so the news page
reloads its headlines.

Contract	Value
Controller	news
Target scopes	chart
Family	news
Implementation	sdk
Permission label	events.control
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · news catalog literal · required when constrained
Revision domains	None
Options index	None

Public SDK signature

() => void

optionChain.clearSelectionwrite · write

OptionChainControllerApi.clearSelection

Contract	Value
Controller	optionChain
Target scopes	widget
Family	optionsView
Implementation	sdk
Permission label	marketdata.write
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · options catalog literal · required when constrained symbols · string · optionChain.current.symbols authority extractor · required when constrained resourceIds · string · optionChain.clearSelection.resourceIds authority extractor · required when constrained resourceKinds · string · optionChain.clearSelection.resourceKinds authority extractor · required when constrained
Revision domains	optionChain
Options index	None

Public SDK signature

clearSelection(options?: OptionChainMutationOptions): boolean

optionChain.getSnapshotread · read

OptionChainControllerApi.getSnapshot

Contract	Value
Controller	optionChain
Target scopes	widget
Family	options
Implementation	sdk
Permission label	marketdata.read
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · options catalog literal · required when constrained optionChain.getSnapshot.dataProjection result filter · dataFields optionChain.getSnapshot.allowedSymbols result filter · symbols optionChain.getSnapshot.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

getSnapshot(): OptionChainSnapshot

optionChain.selectContractwrite · write

OptionChainControllerApi.selectContract

Contract	Value
Controller	optionChain
Target scopes	widget
Family	optionsView
Implementation	sdk
Permission label	marketdata.write
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · options catalog literal · required when constrained symbols · string · optionChain.selectContract.symbols authority extractor · required when constrained resourceIds · string · optionChain.selectContract.resourceIds authority extractor · required when constrained resourceKinds · string · optionChain.selectContract.resourceKinds authority extractor · required when constrained
Revision domains	optionChain
Options index	None

Public SDK signature

selectContract(selection: OptionChainSelectionIntent, options?: OptionChainMutationOptions): boolean

optionChain.setExpirationwrite · write

OptionChainControllerApi.setExpiration

Contract	Value
Controller	optionChain
Target scopes	widget
Family	optionsView
Implementation	sdk
Permission label	marketdata.write
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · options catalog literal · required when constrained symbols · string · optionChain.current.symbols authority extractor · required when constrained
Revision domains	optionChain
Options index	None

Public SDK signature

setExpiration(expiration: string, options?: OptionChainMutationOptions): boolean

optionChain.setSelectedContractwrite · write

OptionChainControllerApi.setSelectedContract

Contract	Value
Controller	optionChain
Target scopes	widget
Family	optionsView
Implementation	sdk
Permission label	marketdata.write
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · options catalog literal · required when constrained symbols · string · optionChain.setSelectedContract.symbols authority extractor · required when constrained resourceIds · string · optionChain.setSelectedContract.resourceIds authority extractor · required when constrained resourceKinds · string · optionChain.setSelectedContract.resourceKinds authority extractor · required when constrained
Revision domains	optionChain
Options index	None

Public SDK signature

setSelectedContract(contract: TradingOptionContract, options?: OptionChainMutationOptions): boolean

optionChain.setStrikeRowswrite · write

OptionChainControllerApi.setStrikeRows

Contract	Value
Controller	optionChain
Target scopes	widget
Family	optionsView
Implementation	sdk
Permission label	marketdata.write
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · options catalog literal · required when constrained maxRows · finite-number · args[0] · required when constrained; signed value symbols · string · optionChain.current.symbols authority extractor · required when constrained
Revision domains	optionChain
Options index	None

Public SDK signature

setStrikeRows(strikeRows: OptionChainStrikeRowCount, options?: OptionChainMutationOptions): boolean

optionTicket.addLegwrite · write

OptionTicketControllerApi.addLeg

Contract	Value
Controller	optionTicket
Target scopes	widget
Family	orderTicket
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · options catalog literal · required when constrained symbols · string · optionTicket.addLeg.symbols authority extractor · required when constrained accounts · string · optionTicket.current.accounts authority extractor · required when constrained resourceIds · string · optionTicket.addLeg.resourceIds authority extractor · required when constrained resourceKinds · string · optionTicket.addLeg.resourceKinds authority extractor · required when constrained orderSides · string · args[0].side · required when constrained maxQuantity · finite-number · optionTicket.addLeg.maxQuantity.sourceUnavailable authority extractor · required when constrained; absolute magnitude
Revision domains	optionTicket
Options index	None

Public SDK signature

addLeg(leg: Readonly<OptionTicketLegState>, options?: OptionTicketMutationOptions): boolean

optionTicket.applyStrategyTemplatewrite · write

OptionTicketControllerApi.applyStrategyTemplate

Contract	Value
Controller	optionTicket
Target scopes	widget
Family	orderTicket
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · options catalog literal · required when constrained symbols · string · optionTicket.applyStrategyTemplate.symbols authority extractor · required when constrained accounts · string · optionTicket.current.accounts authority extractor · required when constrained resourceIds · string · optionTicket.applyStrategyTemplate.resourceIds authority extractor · required when constrained resourceKinds · string · optionTicket.applyStrategyTemplate.resourceKinds authority extractor · required when constrained orderSides · string · optionTicket.applyStrategyTemplate.orderSides authority extractor · required when constrained maxQuantity · finite-number · optionTicket.applyStrategyTemplate.maxQuantity.sourceUnavailable authority extractor · required when constrained; absolute magnitude
Revision domains	optionTicket
Options index	None

Public SDK signature

applyStrategyTemplate(input: OptionTicketApplyStrategyInput, options?: OptionTicketMutationOptions): boolean

optionTicket.clearMessagewrite · write

OptionTicketControllerApi.clearMessage

Contract	Value
Controller	optionTicket
Target scopes	widget
Family	orderTicket
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · optionTicket.current.symbols authority extractor · required when constrained accounts · string · optionTicket.current.accounts authority extractor · required when constrained
Revision domains	optionTicket
Options index	None

Public SDK signature

clearMessage(options?: OptionTicketMutationOptions): boolean

optionTicket.getSnapshotread · read

OptionTicketControllerApi.getSnapshot

Contract	Value
Controller	optionTicket
Target scopes	widget
Family	options
Implementation	sdk
Permission label	trading.read
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · options catalog literal · required when constrained optionTicket.getSnapshot.dataProjection result filter · dataFields, maxRows optionTicket.getSnapshot.allowedSymbolsAccounts result filter · symbols, accounts optionTicket.getSnapshot.allowedResources result filter · resourceIds, resourceKinds optionTicket.getSnapshot.tradePolicy result filter · orderTypes, orderSides, timeInForce, maxQuantity
Revision domains	None
Options index	None

Public SDK signature

getSnapshot(): OptionTicketSnapshot

optionTicket.isReadyread · read

OptionTicketControllerApi.isReady

Contract	Value
Controller	optionTicket
Target scopes	widget
Family	options
Implementation	sdk
Permission label	trading.read
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	None
Options index	None

Public SDK signature

isReady(): boolean

optionTicket.removeLegwrite · write

OptionTicketControllerApi.removeLeg

Contract	Value
Controller	optionTicket
Target scopes	widget
Family	orderTicket
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · options catalog literal · required when constrained symbols · string · optionTicket.current.symbols authority extractor · required when constrained accounts · string · optionTicket.current.accounts authority extractor · required when constrained resourceIds · string · optionTicket.removeLeg.resourceIds authority extractor · required when constrained resourceKinds · string · optionTicket.removeLeg.resourceKinds authority extractor · required when constrained
Revision domains	optionTicket
Options index	None

Public SDK signature

removeLeg(id: string, options?: OptionTicketMutationOptions): boolean

optionTicket.replaceCustomFieldswrite · write

OptionTicketControllerApi.replaceCustomFields

Contract	Value
Controller	optionTicket
Target scopes	widget
Family	orderTicket
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	optionTicket
Options index	None

Public SDK signature

replaceCustomFields(values: Readonly<TradingCustomFields>, options?: OptionTicketMutationOptions): boolean

optionTicket.replaceLegswrite · write

OptionTicketControllerApi.replaceLegs

Contract	Value
Controller	optionTicket
Target scopes	widget
Family	orderTicket
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · options catalog literal · required when constrained symbols · string · optionTicket.replaceLegs.symbols authority extractor · required when constrained accounts · string · optionTicket.current.accounts authority extractor · required when constrained resourceIds · string · optionTicket.replaceLegs.resourceIds authority extractor · required when constrained resourceKinds · string · optionTicket.replaceLegs.resourceKinds authority extractor · required when constrained orderSides · string · optionTicket.replaceLegs.orderSides authority extractor · required when constrained maxQuantity · finite-number · optionTicket.replaceLegs.maxQuantity.sourceUnavailable authority extractor · required when constrained; absolute magnitude
Revision domains	optionTicket
Options index	None

Public SDK signature

replaceLegs(
    optionLegs: readonly Readonly<OptionTicketLegState>[],
    equityLegs?: readonly Readonly<TradingEquityStrategyOrderLegDraft>[],
    options?: OptionTicketMutationOptions,
  ): boolean

optionTicket.setActiveLegwrite · write

OptionTicketControllerApi.setActiveLeg

Contract	Value
Controller	optionTicket
Target scopes	widget
Family	orderTicket
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · options catalog literal · required when constrained symbols · string · optionTicket.current.symbols authority extractor · required when constrained accounts · string · optionTicket.current.accounts authority extractor · required when constrained resourceIds · string · optionTicket.setActiveLeg.resourceIds authority extractor · required when constrained resourceKinds · string · optionTicket.setActiveLeg.resourceKinds authority extractor · required when constrained
Revision domains	optionTicket
Options index	None

Public SDK signature

setActiveLeg(id: string, options?: OptionTicketMutationOptions): boolean

optionTicket.setCustomFieldwrite · write

OptionTicketControllerApi.setCustomField

Contract	Value
Controller	optionTicket
Target scopes	widget
Family	orderTicket
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	optionTicket
Options index	None

Public SDK signature

setCustomField(fieldId: string, value: unknown, options?: OptionTicketMutationOptions): boolean

optionTicket.setDurationwrite · write

OptionTicketControllerApi.setDuration

Contract	Value
Controller	optionTicket
Target scopes	widget
Family	orderTicket
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · optionTicket.current.symbols authority extractor · required when constrained accounts · string · optionTicket.current.accounts authority extractor · required when constrained timeInForce · string · args[0] · required when constrained
Revision domains	optionTicket
Options index	None

Public SDK signature

setDuration(duration: OptionTicketDuration, options?: OptionTicketMutationOptions): boolean

optionTicket.setLimitPricewrite · write

OptionTicketControllerApi.setLimitPrice

Contract	Value
Controller	optionTicket
Target scopes	widget
Family	orderTicket
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · optionTicket.current.symbols authority extractor · required when constrained accounts · string · optionTicket.current.accounts authority extractor · required when constrained
Revision domains	optionTicket
Options index	None

Public SDK signature

setLimitPrice(limitPrice: string, options?: OptionTicketMutationOptions): boolean

optionTicket.setMessagewrite · write

OptionTicketControllerApi.setMessage

Contract	Value
Controller	optionTicket
Target scopes	widget
Family	orderTicket
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · optionTicket.current.symbols authority extractor · required when constrained accounts · string · optionTicket.current.accounts authority extractor · required when constrained
Revision domains	optionTicket
Options index	None

Public SDK signature

setMessage(message: string | null, messageOk?: boolean, options?: OptionTicketMutationOptions): boolean

optionTicket.setOrderTypewrite · write

OptionTicketControllerApi.setOrderType

Contract	Value
Controller	optionTicket
Target scopes	widget
Family	orderTicket
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · optionTicket.current.symbols authority extractor · required when constrained accounts · string · optionTicket.current.accounts authority extractor · required when constrained orderTypes · string · args[0] · required when constrained
Revision domains	optionTicket
Options index	None

Public SDK signature

setOrderType(orderType: OptionTicketOrderType, options?: OptionTicketMutationOptions): boolean

optionTicket.submittrade · financial

OptionTicketControllerApi.submit

Contract	Value
Controller	optionTicket
Target scopes	widget
Family	orders
Implementation	sdk
Permission label	trading.write
Financial risk classes	risk-increasing
Decision receipt	always
Input constraints	dataDomains · string · options catalog literal · required when constrained symbols · string · optionTicket.current.symbols authority extractor · required when constrained accounts · string · optionTicket.current.accounts authority extractor · required when constrained resourceIds · string · optionTicket.submit.resourceIds authority extractor · required when constrained resourceKinds · string · optionTicket.submit.resourceKinds authority extractor · required when constrained optionTicket.submit.allowedSymbolsAccounts result filter · symbols, accounts
Revision domains	optionTicket
Options index	0

Public SDK signature

submit(options?: OptionTicketMutationOptions): Promise<OptionTicketSubmitOutcome>

optionTicket.updateLegwrite · write

OptionTicketControllerApi.updateLeg

Contract	Value
Controller	optionTicket
Target scopes	widget
Family	orderTicket
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · options catalog literal · required when constrained symbols · string · optionTicket.updateLeg.symbols authority extractor · required when constrained accounts · string · optionTicket.current.accounts authority extractor · required when constrained resourceIds · string · optionTicket.updateLeg.resourceIds authority extractor · required when constrained resourceKinds · string · optionTicket.updateLeg.resourceKinds authority extractor · required when constrained orderSides · string · optionTicket.updateLeg.orderSides authority extractor · required when constrained maxQuantity · finite-number · optionTicket.updateLeg.maxQuantity.sourceUnavailable authority extractor · required when constrained; absolute magnitude
Revision domains	optionTicket
Options index	None

Public SDK signature

updateLeg(id: string, patch: Partial<Omit<OptionTicketLegState, 'id'>>, options?: OptionTicketMutationOptions): boolean

orderFlow.clearwrite · write

OrderFlowControllerApi.clear

Contract	Value
Controller	orderFlow
Target scopes	widget
Family	orderFlow
Implementation	sdk
Permission label	marketdata.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · orderFlow.current.symbols authority extractor · required when constrained
Revision domains	orderFlow
Options index	None

Public SDK signature

clear(): boolean

orderFlow.getContextread · read

OrderFlowControllerApi.getContext

Contract	Value
Controller	orderFlow
Target scopes	widget
Family	orderFlow
Implementation	sdk
Permission label	marketdata.read
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · l2 catalog literal, tape catalog literal · required when constrained orderFlow.getContext.dataProjection result filter · dataFields, maxRows, maxHistoryLookbackMs, maxMarketDataAgeMs orderFlow.getContext.allowedSymbols result filter · symbols
Revision domains	None
Options index	None

Public SDK signature

getContext(options?: OrderFlowContextOptions): OrderFlowContextSnapshot

orderFlow.setConfigwrite · write

OrderFlowControllerApi.setConfig

Contract	Value
Controller	orderFlow
Target scopes	widget
Family	orderFlow
Implementation	sdk
Permission label	marketdata.write
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · l2 catalog literal, tape catalog literal · required when constrained symbols · string · orderFlow.current.symbols authority extractor · required when constrained
Revision domains	orderFlow
Options index	None

Public SDK signature

setConfig(config: Partial<OrderFlowConfiguration>): Promise<boolean>

orderFlow.setSymbolwrite · write

OrderFlowControllerApi.setSymbol

Contract	Value
Controller	orderFlow
Target scopes	widget
Family	orderFlow
Implementation	sdk
Permission label	marketdata.write
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · l2 catalog literal, tape catalog literal · required when constrained symbols · string · orderFlow.setSymbol.symbols authority extractor · required when constrained
Revision domains	orderFlow
Options index	None

Public SDK signature

setSymbol(symbol: SdkSymbolInfo | undefined): Promise<void>

orderTicket.addExitLevelDraftwrite · write

OrderTicketControllerApi.addExitLevelDraft

Contract	Value
Controller	orderTicket
Target scopes	widget
Family	orderTicket
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · orderTicket.current.symbols authority extractor · required when constrained accounts · string · orderTicket.current.accounts authority extractor · required when constrained resourceIds · string · orderTicket.addExitLevelDraft.resourceIds authority extractor · required when constrained resourceKinds · string · orderTicket.addExitLevelDraft.resourceKinds authority extractor · required when constrained maxQuantity · finite-number · orderTicket.addExitLevelDraft.maxQuantity.sourceUnavailable authority extractor · required when constrained; absolute magnitude
Revision domains	orderTicket
Options index	None

Public SDK signature

addExitLevelDraft(level: OrderTicketExitLevelState, options?: OrderTicketMutationOptions): boolean

orderTicket.clearMessagewrite · write

OrderTicketControllerApi.clearMessage

Contract	Value
Controller	orderTicket
Target scopes	widget
Family	orderTicket
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · orderTicket.current.symbols authority extractor · required when constrained accounts · string · orderTicket.current.accounts authority extractor · required when constrained
Revision domains	orderTicket
Options index	None

Public SDK signature

clearMessage(options?: OrderTicketMutationOptions): boolean

orderTicket.confirmExitLevelswrite · write

OrderTicketControllerApi.confirmExitLevels

Contract	Value
Controller	orderTicket
Target scopes	widget
Family	orderTicket
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · orderTicket.current.symbols authority extractor · required when constrained accounts · string · orderTicket.current.accounts authority extractor · required when constrained resourceIds · string · orderTicket.confirmExitLevels.resourceIds authority extractor · required when constrained resourceKinds · string · orderTicket.confirmExitLevels.resourceKinds authority extractor · required when constrained
Revision domains	orderTicket
Options index	None

Public SDK signature

confirmExitLevels(options?: OrderTicketMutationOptions): boolean

orderTicket.confirmPreviewtrade · financial

OrderTicketControllerApi.confirmPreview

Contract	Value
Controller	orderTicket
Target scopes	widget
Family	orders
Implementation	sdk
Permission label	trading.write
Financial risk classes	risk-increasing
Decision receipt	always
Input constraints	symbols · string · orderTicket.current.symbols authority extractor · required when constrained accounts · string · orderTicket.current.accounts authority extractor · required when constrained resourceIds · string · orderTicket.confirmPreview.resourceIds authority extractor · required when constrained resourceKinds · string · orderTicket.confirmPreview.resourceKinds authority extractor · required when constrained
Revision domains	orderTicket
Options index	0

Public SDK signature

confirmPreview(options?: OrderTicketMutationOptions): Promise<OrderTicketActionOutcome>

orderTicket.discardExitLevelswrite · write

OrderTicketControllerApi.discardExitLevels

Contract	Value
Controller	orderTicket
Target scopes	widget
Family	orderTicket
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · orderTicket.current.symbols authority extractor · required when constrained accounts · string · orderTicket.current.accounts authority extractor · required when constrained resourceIds · string · orderTicket.discardExitLevels.resourceIds authority extractor · required when constrained resourceKinds · string · orderTicket.discardExitLevels.resourceKinds authority extractor · required when constrained
Revision domains	orderTicket
Options index	None

Public SDK signature

discardExitLevels(options?: OrderTicketMutationOptions): boolean

orderTicket.discardPreviewwrite · write

OrderTicketControllerApi.discardPreview

Contract	Value
Controller	orderTicket
Target scopes	widget
Family	orderTicket
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · orderTicket.current.symbols authority extractor · required when constrained accounts · string · orderTicket.current.accounts authority extractor · required when constrained
Revision domains	orderTicket
Options index	None

Public SDK signature

discardPreview(options?: OrderTicketMutationOptions): boolean

orderTicket.getSnapshotread · read

OrderTicketControllerApi.getSnapshot

Contract	Value
Controller	orderTicket
Target scopes	widget
Family	trading
Implementation	sdk
Permission label	trading.read
Financial risk classes	None
Decision receipt	None
Input constraints	orderTicket.getSnapshot.allowedSymbolsAccounts result filter · symbols, accounts orderTicket.getSnapshot.allowedResources result filter · resourceIds, resourceKinds orderTicket.getSnapshot.tradePolicy result filter · orderTypes, orderSides, timeInForce, maxQuantity
Revision domains	None
Options index	None

Public SDK signature

getSnapshot(): OrderTicketSnapshot

orderTicket.isReadyread · read

OrderTicketControllerApi.isReady

Contract	Value
Controller	orderTicket
Target scopes	widget
Family	trading
Implementation	sdk
Permission label	trading.read
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	None
Options index	None

Public SDK signature

isReady(): boolean

orderTicket.openExitLevelsEditorwrite · write

OrderTicketControllerApi.openExitLevelsEditor

Contract	Value
Controller	orderTicket
Target scopes	widget
Family	orderTicket
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · orderTicket.current.symbols authority extractor · required when constrained accounts · string · orderTicket.current.accounts authority extractor · required when constrained resourceIds · string · orderTicket.openExitLevelsEditor.resourceIds authority extractor · required when constrained resourceKinds · string · orderTicket.openExitLevelsEditor.resourceKinds authority extractor · required when constrained maxQuantity · finite-number · orderTicket.openExitLevelsEditor.maxQuantity.sourceUnavailable authority extractor · required when constrained; absolute magnitude
Revision domains	orderTicket
Options index	None

Public SDK signature

openExitLevelsEditor(
    levels?: readonly OrderTicketExitLevelState[],
    options?: OrderTicketMutationOptions,
  ): boolean

orderTicket.removeExitLevelwrite · write

OrderTicketControllerApi.removeExitLevel

Contract	Value
Controller	orderTicket
Target scopes	widget
Family	orderTicket
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · orderTicket.current.symbols authority extractor · required when constrained accounts · string · orderTicket.current.accounts authority extractor · required when constrained resourceIds · string · orderTicket.removeExitLevel.resourceIds authority extractor · required when constrained resourceKinds · string · orderTicket.removeExitLevel.resourceKinds authority extractor · required when constrained
Revision domains	orderTicket
Options index	None

Public SDK signature

removeExitLevel(id: string, options?: OrderTicketMutationOptions): boolean

orderTicket.removeExitLevelDraftwrite · write

OrderTicketControllerApi.removeExitLevelDraft

Contract	Value
Controller	orderTicket
Target scopes	widget
Family	orderTicket
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · orderTicket.current.symbols authority extractor · required when constrained accounts · string · orderTicket.current.accounts authority extractor · required when constrained resourceIds · string · orderTicket.removeExitLevelDraft.resourceIds authority extractor · required when constrained resourceKinds · string · orderTicket.removeExitLevelDraft.resourceKinds authority extractor · required when constrained
Revision domains	orderTicket
Options index	None

Public SDK signature

removeExitLevelDraft(id: string, options?: OrderTicketMutationOptions): boolean

orderTicket.replaceCustomFieldswrite · write

OrderTicketControllerApi.replaceCustomFields

Contract	Value
Controller	orderTicket
Target scopes	widget
Family	orderTicket
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · orderTicket.current.symbols authority extractor · required when constrained accounts · string · orderTicket.current.accounts authority extractor · required when constrained resourceIds · string · orderTicket.replaceCustomFields.resourceIds authority extractor · required when constrained resourceKinds · string · orderTicket.replaceCustomFields.resourceKinds authority extractor · required when constrained
Revision domains	orderTicket
Options index	None

Public SDK signature

replaceCustomFields(values: Readonly<Record<string, unknown>>, options?: OrderTicketMutationOptions): boolean

orderTicket.replaceExitLevelswrite · write

OrderTicketControllerApi.replaceExitLevels

Contract	Value
Controller	orderTicket
Target scopes	widget
Family	orderTicket
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · orderTicket.current.symbols authority extractor · required when constrained accounts · string · orderTicket.current.accounts authority extractor · required when constrained resourceIds · string · orderTicket.replaceExitLevels.resourceIds authority extractor · required when constrained resourceKinds · string · orderTicket.replaceExitLevels.resourceKinds authority extractor · required when constrained maxQuantity · finite-number · orderTicket.replaceExitLevels.maxQuantity.sourceUnavailable authority extractor · required when constrained; absolute magnitude
Revision domains	orderTicket
Options index	None

Public SDK signature

replaceExitLevels(
    levels: readonly OrderTicketExitLevelState[],
    options?: OrderTicketMutationOptions,
  ): boolean

orderTicket.replaceUserSettingswrite · write

OrderTicketControllerApi.replaceUserSettings

Contract	Value
Controller	orderTicket
Target scopes	widget
Family	orderTicket
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · orderTicket.current.symbols authority extractor · required when constrained accounts · string · orderTicket.current.accounts authority extractor · required when constrained
Revision domains	orderTicket
Options index	None

Public SDK signature

replaceUserSettings(values: Readonly<TradingTicketUserSettings>, options?: OrderTicketPersistenceMutationOptions): boolean

orderTicket.setAttachedStopLosswrite · write

OrderTicketControllerApi.setAttachedStopLoss

Contract	Value
Controller	orderTicket
Target scopes	widget
Family	orderTicket
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · orderTicket.current.symbols authority extractor · required when constrained accounts · string · orderTicket.current.accounts authority extractor · required when constrained resourceIds · string · orderTicket.setAttachedStopLoss.resourceIds authority extractor · required when constrained resourceKinds · string · orderTicket.setAttachedStopLoss.resourceKinds authority extractor · required when constrained
Revision domains	orderTicket
Options index	None

Public SDK signature

setAttachedStopLoss(
    input: OrderTicketAttachedStopLossInput,
    options?: OrderTicketMutationOptions,
  ): boolean

orderTicket.setAttachedTakeProfitwrite · write

OrderTicketControllerApi.setAttachedTakeProfit

Contract	Value
Controller	orderTicket
Target scopes	widget
Family	orderTicket
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · orderTicket.current.symbols authority extractor · required when constrained accounts · string · orderTicket.current.accounts authority extractor · required when constrained resourceIds · string · orderTicket.setAttachedTakeProfit.resourceIds authority extractor · required when constrained resourceKinds · string · orderTicket.setAttachedTakeProfit.resourceKinds authority extractor · required when constrained
Revision domains	orderTicket
Options index	None

Public SDK signature

setAttachedTakeProfit(
    input: OrderTicketAttachedTakeProfitInput,
    options?: OrderTicketMutationOptions,
  ): boolean

orderTicket.setBracketSizingwrite · write

OrderTicketControllerApi.setBracketSizing

Contract	Value
Controller	orderTicket
Target scopes	widget
Family	orderTicket
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · orderTicket.current.symbols authority extractor · required when constrained accounts · string · orderTicket.current.accounts authority extractor · required when constrained resourceIds · string · orderTicket.setBracketSizing.resourceIds authority extractor · required when constrained resourceKinds · string · orderTicket.setBracketSizing.resourceKinds authority extractor · required when constrained
Revision domains	orderTicket
Options index	None

Public SDK signature

setBracketSizing(input: OrderTicketBracketSizingInput, options?: OrderTicketMutationOptions): boolean

orderTicket.setCustomFieldwrite · write

OrderTicketControllerApi.setCustomField

Contract	Value
Controller	orderTicket
Target scopes	widget
Family	orderTicket
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · orderTicket.current.symbols authority extractor · required when constrained accounts · string · orderTicket.current.accounts authority extractor · required when constrained resourceIds · string · orderTicket.setCustomField.resourceIds authority extractor · required when constrained resourceKinds · string · orderTicket.setCustomField.resourceKinds authority extractor · required when constrained
Revision domains	orderTicket
Options index	None

Public SDK signature

setCustomField(fieldId: string, value: unknown, options?: OrderTicketMutationOptions): boolean

orderTicket.setDirectionwrite · write

OrderTicketControllerApi.setDirection

Contract	Value
Controller	orderTicket
Target scopes	widget
Family	orderTicket
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · orderTicket.current.symbols authority extractor · required when constrained accounts · string · orderTicket.current.accounts authority extractor · required when constrained orderSides · string · orderTicket.setDirection.orderSides authority extractor · required when constrained
Revision domains	orderTicket
Options index	None

Public SDK signature

setDirection(direction: OrderTicketDirection, options?: OrderTicketMutationOptions): boolean

orderTicket.setDurationwrite · write

OrderTicketControllerApi.setDuration

Contract	Value
Controller	orderTicket
Target scopes	widget
Family	orderTicket
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · orderTicket.current.symbols authority extractor · required when constrained accounts · string · orderTicket.current.accounts authority extractor · required when constrained timeInForce · string · orderTicket.setDuration.timeInForce.sourceUnavailable authority extractor · required when constrained
Revision domains	orderTicket
Options index	None

Public SDK signature

setDuration(value: string, options?: OrderTicketMutationOptions): boolean

orderTicket.setDurationExpirywrite · write

OrderTicketControllerApi.setDurationExpiry

Contract	Value
Controller	orderTicket
Target scopes	widget
Family	orderTicket
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · orderTicket.current.symbols authority extractor · required when constrained accounts · string · orderTicket.current.accounts authority extractor · required when constrained
Revision domains	orderTicket
Options index	None

Public SDK signature

setDurationExpiry(
    expiry: { date?: string; time?: string },
    options?: OrderTicketMutationOptions,
  ): boolean

orderTicket.setOrderPriceTickswrite · write

OrderTicketControllerApi.setOrderPriceTicks

Contract	Value
Controller	orderTicket
Target scopes	widget
Family	orderTicket
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · orderTicket.current.symbols authority extractor · required when constrained accounts · string · orderTicket.current.accounts authority extractor · required when constrained
Revision domains	orderTicket
Options index	None

Public SDK signature

setOrderPriceTicks(value: string, options?: OrderTicketMutationOptions): boolean

orderTicket.setOrderTypewrite · write

OrderTicketControllerApi.setOrderType

Contract	Value
Controller	orderTicket
Target scopes	widget
Family	orderTicket
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · orderTicket.current.symbols authority extractor · required when constrained accounts · string · orderTicket.current.accounts authority extractor · required when constrained orderTypes · string · args[0] · required when constrained
Revision domains	orderTicket
Options index	None

Public SDK signature

setOrderType(orderType: TradingOrderType, options?: OrderTicketMutationOptions): boolean

orderTicket.setPostOnlywrite · write

OrderTicketControllerApi.setPostOnly

Contract	Value
Controller	orderTicket
Target scopes	widget
Family	orderTicket
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · orderTicket.current.symbols authority extractor · required when constrained accounts · string · orderTicket.current.accounts authority extractor · required when constrained
Revision domains	orderTicket
Options index	None

Public SDK signature

setPostOnly(value: boolean, options?: OrderTicketMutationOptions): boolean

orderTicket.setPricewrite · write

OrderTicketControllerApi.setPrice

Contract	Value
Controller	orderTicket
Target scopes	widget
Family	orderTicket
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · orderTicket.current.symbols authority extractor · required when constrained accounts · string · orderTicket.current.accounts authority extractor · required when constrained
Revision domains	orderTicket
Options index	None

Public SDK signature

setPrice(value: string, options?: OrderTicketMutationOptions): boolean

orderTicket.setQuantitywrite · write

OrderTicketControllerApi.setQuantity

Contract	Value
Controller	orderTicket
Target scopes	widget
Family	orderTicket
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · orderTicket.current.symbols authority extractor · required when constrained accounts · string · orderTicket.current.accounts authority extractor · required when constrained maxQuantity · finite-number · orderTicket.setQuantity.maxQuantity.sourceUnavailable authority extractor · required when constrained; absolute magnitude
Revision domains	orderTicket
Options index	None

Public SDK signature

setQuantity(quantity: string, options?: OrderTicketPersistenceMutationOptions): boolean

orderTicket.setQuantityMoneyRiskwrite · write

OrderTicketControllerApi.setQuantityMoneyRisk

Contract	Value
Controller	orderTicket
Target scopes	widget
Family	orderTicket
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · orderTicket.current.symbols authority extractor · required when constrained accounts · string · orderTicket.current.accounts authority extractor · required when constrained
Revision domains	orderTicket
Options index	None

Public SDK signature

setQuantityMoneyRisk(value: string, options?: OrderTicketMutationOptions): boolean

orderTicket.setQuantityPercentRiskwrite · write

OrderTicketControllerApi.setQuantityPercentRisk

Contract	Value
Controller	orderTicket
Target scopes	widget
Family	orderTicket
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · orderTicket.current.symbols authority extractor · required when constrained accounts · string · orderTicket.current.accounts authority extractor · required when constrained
Revision domains	orderTicket
Options index	None

Public SDK signature

setQuantityPercentRisk(value: string, options?: OrderTicketMutationOptions): boolean

orderTicket.setSectionExpandedwrite · write

OrderTicketControllerApi.setSectionExpanded

Contract	Value
Controller	orderTicket
Target scopes	widget
Family	orderTicket
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · orderTicket.current.symbols authority extractor · required when constrained accounts · string · orderTicket.current.accounts authority extractor · required when constrained
Revision domains	orderTicket
Options index	None

Public SDK signature

setSectionExpanded(
    section: OrderTicketSectionId,
    expanded: boolean,
    options?: OrderTicketMutationOptions,
  ): boolean

orderTicket.setSettingsOpenwrite · write

OrderTicketControllerApi.setSettingsOpen

Contract	Value
Controller	orderTicket
Target scopes	widget
Family	orderTicket
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · orderTicket.current.symbols authority extractor · required when constrained accounts · string · orderTicket.current.accounts authority extractor · required when constrained
Revision domains	orderTicket
Options index	None

Public SDK signature

setSettingsOpen(open: boolean, options?: OrderTicketMutationOptions): boolean

orderTicket.setStopPricewrite · write

OrderTicketControllerApi.setStopPrice

Contract	Value
Controller	orderTicket
Target scopes	widget
Family	orderTicket
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · orderTicket.current.symbols authority extractor · required when constrained accounts · string · orderTicket.current.accounts authority extractor · required when constrained
Revision domains	orderTicket
Options index	None

Public SDK signature

setStopPrice(value: string, options?: OrderTicketMutationOptions): boolean

orderTicket.setTrailPercentwrite · write

OrderTicketControllerApi.setTrailPercent

Contract	Value
Controller	orderTicket
Target scopes	widget
Family	orderTicket
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · orderTicket.current.symbols authority extractor · required when constrained accounts · string · orderTicket.current.accounts authority extractor · required when constrained
Revision domains	orderTicket
Options index	None

Public SDK signature

setTrailPercent(value: string, options?: OrderTicketMutationOptions): boolean

orderTicket.setUserSettingwrite · write

OrderTicketControllerApi.setUserSetting

Contract	Value
Controller	orderTicket
Target scopes	widget
Family	orderTicket
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · orderTicket.current.symbols authority extractor · required when constrained accounts · string · orderTicket.current.accounts authority extractor · required when constrained
Revision domains	orderTicket
Options index	None

Public SDK signature

setUserSetting(
    key: TradingTicketUserSettingKey,
    value: boolean,
    options?: OrderTicketPersistenceMutationOptions,
  ): boolean

orderTicket.submittrade · financial

OrderTicketControllerApi.submit

Contract	Value
Controller	orderTicket
Target scopes	widget
Family	orders
Implementation	sdk
Permission label	trading.write
Financial risk classes	risk-increasing
Decision receipt	always
Input constraints	symbols · string · orderTicket.current.symbols authority extractor · required when constrained accounts · string · orderTicket.current.accounts authority extractor · required when constrained resourceIds · string · orderTicket.submit.resourceIds authority extractor · required when constrained resourceKinds · string · orderTicket.submit.resourceKinds authority extractor · required when constrained
Revision domains	orderTicket
Options index	0

Public SDK signature

submit(options?: OrderTicketMutationOptions): Promise<OrderTicketActionOutcome>

orderTicket.updateExitLevelDraftwrite · write

OrderTicketControllerApi.updateExitLevelDraft

Contract	Value
Controller	orderTicket
Target scopes	widget
Family	orderTicket
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · orderTicket.current.symbols authority extractor · required when constrained accounts · string · orderTicket.current.accounts authority extractor · required when constrained resourceIds · string · orderTicket.updateExitLevelDraft.resourceIds authority extractor · required when constrained resourceKinds · string · orderTicket.updateExitLevelDraft.resourceKinds authority extractor · required when constrained maxQuantity · finite-number · orderTicket.updateExitLevelDraft.maxQuantity.sourceUnavailable authority extractor · required when constrained; absolute magnitude
Revision domains	orderTicket
Options index	None

Public SDK signature

updateExitLevelDraft(
    id: string,
    patch: Partial<Omit<OrderTicketExitLevelState, 'id'>>,
    options?: OrderTicketMutationOptions,
  ): boolean

orderTicketLauncher.closewrite · write

BrokerOrderTicketLauncherControllerApi.close

Contract	Value
Controller	orderTicketLauncher
Target scopes	widget
Family	orderTicket
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	orderTicketLauncher
Options index	None

Public SDK signature

close(options?: BrokerOrderTicketLauncherMutationOptions): boolean

orderTicketLauncher.getSnapshotread · read

BrokerOrderTicketLauncherControllerApi.getSnapshot

Contract	Value
Controller	orderTicketLauncher
Target scopes	widget
Family	trading
Implementation	sdk
Permission label	trading.read
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	None
Options index	None

Public SDK signature

getSnapshot(): BrokerOrderTicketLauncherSnapshot

orderTicketLauncher.invokewrite · write

BrokerOrderTicketLauncherControllerApi.invoke

Contract	Value
Controller	orderTicketLauncher
Target scopes	widget
Family	orderTicket
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	orderTicketLauncher
Options index	None

Public SDK signature

invoke(
    invocation: BrokerOrderTicketInvocation,
    options?: BrokerOrderTicketLauncherMutationOptions,
  ): BrokerOrderTicketLauncherInvocationOutcome

orderTicketLauncher.openwrite · write

BrokerOrderTicketLauncherControllerApi.open

Contract	Value
Controller	orderTicketLauncher
Target scopes	widget
Family	orderTicket
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	orderTicketLauncher
Options index	None

Public SDK signature

open(options?: BrokerOrderTicketLauncherMutationOptions): boolean

panelLayout.activatePanelwrite · write

PanelLayoutControllerApi.activatePanel

Contract	Value
Controller	panelLayout
Target scopes	session, widget
Family	terminalLayout
Implementation	sdk
Permission label	host.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · panelLayout.activatePanel.resourceIds authority extractor · required when constrained resourceKinds · string · panelLayout.activatePanel.resourceKinds authority extractor · required when constrained
Revision domains	layout
Options index	None

Public SDK signature

activatePanel(panelId: string): boolean

panelLayout.addWidgetwrite · write

PanelLayoutControllerApi.addWidget

Contract	Value
Controller	panelLayout
Target scopes	session, widget
Family	terminalLayout
Implementation	sdk
Permission label	host.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · panelLayout.addWidget.resourceIds authority extractor · required when constrained resourceKinds · string · panelLayout.addWidget.resourceKinds authority extractor · required when constrained
Revision domains	layout
Options index	None

Public SDK signature

addWidget(widgetType: string, options?: WidgetLayoutAddWidgetOptions): string | undefined

panelLayout.clearLayoutwrite · write

PanelLayoutControllerApi.clearLayout

Contract	Value
Controller	panelLayout
Target scopes	session, widget
Family	terminalLayout
Implementation	sdk
Permission label	host.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · panelLayout.clearLayout.resourceIds authority extractor · required when constrained resourceKinds · string · panelLayout.clearLayout.resourceKinds authority extractor · required when constrained
Revision domains	layout
Options index	None

Public SDK signature

clearLayout(): boolean

panelLayout.closeGroupwrite · write

PanelLayoutControllerApi.closeGroup

Contract	Value
Controller	panelLayout
Target scopes	session, widget
Family	terminalLayout
Implementation	sdk
Permission label	host.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · panelLayout.closeGroup.resourceIds authority extractor · required when constrained resourceKinds · string · panelLayout.closeGroup.resourceKinds authority extractor · required when constrained
Revision domains	layout
Options index	None

Public SDK signature

closeGroup(groupId: string): boolean

panelLayout.closePanelwrite · write

PanelLayoutControllerApi.closePanel

Contract	Value
Controller	panelLayout
Target scopes	session, widget
Family	terminalLayout
Implementation	sdk
Permission label	host.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · panelLayout.closePanel.resourceIds authority extractor · required when constrained resourceKinds · string · panelLayout.closePanel.resourceKinds authority extractor · required when constrained
Revision domains	layout
Options index	None

Public SDK signature

closePanel(panelId: string): boolean

panelLayout.getSnapshotread · read

PanelLayoutControllerApi.getSnapshot

Contract	Value
Controller	panelLayout
Target scopes	session, widget
Family	terminalLayout
Implementation	sdk
Permission label	host.control
Financial risk classes	None
Decision receipt	None
Input constraints	panelLayout.getSnapshot.allowedSymbolsAccounts result filter · symbols, accounts panelLayout.getSnapshot.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

getSnapshot(): PanelLayoutSnapshot

panelLayout.isReadyread · read

PanelLayoutControllerApi.isReady

Contract	Value
Controller	panelLayout
Target scopes	session, widget
Family	terminalLayout
Implementation	sdk
Permission label	host.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	None
Options index	None

Public SDK signature

isReady(): boolean

panelLayout.listPanelsread · read

PanelLayoutControllerApi.listPanels

Contract	Value
Controller	panelLayout
Target scopes	session, widget
Family	terminalLayout
Implementation	sdk
Permission label	host.control
Financial risk classes	None
Decision receipt	None
Input constraints	panelLayout.listPanels.allowedSymbolsAccounts result filter · symbols, accounts panelLayout.listPanels.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

listPanels(): readonly PanelLayoutPanelState[]

panelLayout.loadPanelArrangementwrite · write

PanelLayoutControllerApi.loadPanelArrangement

Contract	Value
Controller	panelLayout
Target scopes	session, widget
Family	terminalLayout
Implementation	sdk
Permission label	host.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · panelLayout.loadPanelArrangement.resourceIds authority extractor · required when constrained resourceKinds · string · panelLayout.loadPanelArrangement.resourceKinds authority extractor · required when constrained
Revision domains	layout
Options index	None

Public SDK signature

loadPanelArrangement(state: WidgetLayoutState): boolean

panelLayout.maximizePanelwrite · write

PanelLayoutControllerApi.maximizePanel

Contract	Value
Controller	panelLayout
Target scopes	session, widget
Family	terminalLayout
Implementation	sdk
Permission label	host.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · panelLayout.maximizePanel.resourceIds authority extractor · required when constrained resourceKinds · string · panelLayout.maximizePanel.resourceKinds authority extractor · required when constrained
Revision domains	layout
Options index	None

Public SDK signature

maximizePanel(panelId: string): boolean

panelLayout.movePanelwrite · write

PanelLayoutControllerApi.movePanel

Contract	Value
Controller	panelLayout
Target scopes	session, widget
Family	terminalLayout
Implementation	sdk
Permission label	host.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · panelLayout.movePanel.resourceIds authority extractor · required when constrained resourceKinds · string · panelLayout.movePanel.resourceKinds authority extractor · required when constrained
Revision domains	layout
Options index	None

Public SDK signature

movePanel(panelId: string, options: PanelLayoutMovePanelOptions): boolean

panelLayout.resizePanelwrite · write

PanelLayoutControllerApi.resizePanel

Contract	Value
Controller	panelLayout
Target scopes	session, widget
Family	terminalLayout
Implementation	sdk
Permission label	host.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · panelLayout.resizePanel.resourceIds authority extractor · required when constrained resourceKinds · string · panelLayout.resizePanel.resourceKinds authority extractor · required when constrained
Revision domains	layout
Options index	None

Public SDK signature

resizePanel(panelId: string, options: PanelLayoutResizePanelOptions): boolean

panelLayout.restorePanelwrite · write

PanelLayoutControllerApi.restorePanel

Contract	Value
Controller	panelLayout
Target scopes	session, widget
Family	terminalLayout
Implementation	sdk
Permission label	host.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · panelLayout.restorePanel.resourceIds authority extractor · required when constrained resourceKinds · string · panelLayout.restorePanel.resourceKinds authority extractor · required when constrained
Revision domains	layout
Options index	None

Public SDK signature

restorePanel(panelId: string): boolean

panelLayout.savePanelArrangementread · read

PanelLayoutControllerApi.savePanelArrangement

Contract	Value
Controller	panelLayout
Target scopes	session, widget
Family	terminalLayout
Implementation	sdk
Permission label	host.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · panelLayout.savePanelArrangement.resourceIds authority extractor · required when constrained resourceKinds · string · panelLayout.savePanelArrangement.resourceKinds authority extractor · required when constrained panelLayout.savePanelArrangement.allowedSymbolsAccounts result filter · symbols, accounts panelLayout.savePanelArrangement.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

savePanelArrangement(): WidgetLayoutState | undefined

panelLayout.setContainerHeightwrite · write

PanelLayoutControllerApi.setContainerHeight

Contract	Value
Controller	panelLayout
Target scopes	session, widget
Family	terminalLayout
Implementation	sdk
Permission label	host.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	layout
Options index	None

Public SDK signature

setContainerHeight(height: number): boolean

panelLayout.setPanelTitlewrite · write

PanelLayoutControllerApi.setPanelTitle

Contract	Value
Controller	panelLayout
Target scopes	session, widget
Family	terminalLayout
Implementation	sdk
Permission label	host.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · panelLayout.setPanelTitle.resourceIds authority extractor · required when constrained resourceKinds · string · panelLayout.setPanelTitle.resourceKinds authority extractor · required when constrained
Revision domains	layout
Options index	None

Public SDK signature

setPanelTitle(panelId: string, title: string): boolean

panelLayout.updatePanelParamswrite · write

PanelLayoutControllerApi.updatePanelParams

Contract	Value
Controller	panelLayout
Target scopes	session, widget
Family	terminalLayout
Implementation	sdk
Permission label	host.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · panelLayout.updatePanelParams.resourceIds authority extractor · required when constrained resourceKinds · string · panelLayout.updatePanelParams.resourceKinds authority extractor · required when constrained
Revision domains	layout
Options index	None

Public SDK signature

updatePanelParams(panelId: string, patch: WidgetLayoutPanelParams): boolean

replay.cancelPickingwrite · write

Leaves picking mode without choosing a start bar and returns the updated state.

Contract	Value
Controller	replay
Target scopes	chart
Family	replay
Implementation	sdk
Permission label	replay.control
Financial risk classes	None
Decision receipt	None
Input constraints	replay.cancelPicking.allowedSymbols result filter · symbols
Revision domains	replay, viewport
Options index	None

Public SDK signature

() => ReplayState

replay.exitwrite · write

Leaves replay mode and returns the updated state.

Contract	Value
Controller	replay
Target scopes	chart
Family	replay
Implementation	sdk
Permission label	replay.control
Financial risk classes	None
Decision receipt	None
Input constraints	replay.exit.allowedSymbols result filter · symbols
Revision domains	replay, viewport
Options index	None

Public SDK signature

() => ReplayState

replay.getStateread · read

Returns the current ReplayState snapshot without changing it.

Contract	Value
Controller	replay
Target scopes	chart
Family	replay
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	replay.getState.allowedSymbols result filter · symbols
Revision domains	None
Options index	None

Public SDK signature

() => ReplayState

replay.jumpToBarwrite · write

Moves the replay cursor directly to the given zero-based bar index and returns the updated
state.

Contract	Value
Controller	replay
Target scopes	chart
Family	replay
Implementation	sdk
Permission label	replay.control
Financial risk classes	None
Decision receipt	None
Input constraints	replay.jumpToBar.allowedSymbols result filter · symbols
Revision domains	replay, viewport
Options index	None

Public SDK signature

(barIndex: number) => ReplayState

replay.loadStatewrite · write

Loads persisted replay state through the chart storage adapter, resolving with null when none
is stored.

Contract	Value
Controller	replay
Target scopes	chart
Family	replay
Implementation	sdk
Permission label	replay.control
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · replay.loadState.symbols authority extractor · required when constrained replay.loadState.allowedSymbols result filter · symbols
Revision domains	replay, viewport
Options index	None

Public SDK signature

(request?: LoadReplayStateRequest) => Promise<ReplayState | null>

replay.pausewrite · write

Pauses playback and returns the updated state.

Contract	Value
Controller	replay
Target scopes	chart
Family	replay
Implementation	sdk
Permission label	replay.control
Financial risk classes	None
Decision receipt	None
Input constraints	replay.pause.allowedSymbols result filter · symbols
Revision domains	replay, viewport
Options index	None

Public SDK signature

() => ReplayState

replay.pickStartBarwrite · write

Selects the zero-based bar index replay starts from and returns the updated state.

Contract	Value
Controller	replay
Target scopes	chart
Family	replay
Implementation	sdk
Permission label	replay.control
Financial risk classes	None
Decision receipt	None
Input constraints	replay.pickStartBar.allowedSymbols result filter · symbols
Revision domains	replay, viewport
Options index	None

Public SDK signature

(barIndex: number, options?: ReplayStartOptions) => ReplayState

replay.playwrite · write

Starts or resumes playback and returns the updated state.

Contract	Value
Controller	replay
Target scopes	chart
Family	replay
Implementation	sdk
Permission label	replay.control
Financial risk classes	None
Decision receipt	None
Input constraints	replay.play.allowedSymbols result filter · symbols
Revision domains	replay, viewport
Options index	None

Public SDK signature

() => ReplayState

replay.saveStatewrite · write

Persists the current replay state — or the state supplied on the request — through the chart
storage adapter.

Contract	Value
Controller	replay
Target scopes	chart
Family	replay
Implementation	sdk
Permission label	replay.control
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · replay.saveState.symbols authority extractor · required when constrained
Revision domains	replay, viewport
Options index	None

Public SDK signature

(request?: Omit<SaveReplayStateRequest, 'state'> & { state?: ReplayState }) => Promise<void>

replay.setSpeedwrite · write

Sets the playback speed multiplier and returns the updated state.

Contract	Value
Controller	replay
Target scopes	chart
Family	replay
Implementation	sdk
Permission label	replay.control
Financial risk classes	None
Decision receipt	None
Input constraints	replay.setSpeed.allowedSymbols result filter · symbols
Revision domains	replay, viewport
Options index	None

Public SDK signature

(speed: number) => ReplayState

replay.startPickingwrite · write

Enters start-bar picking mode and returns the updated state.

Contract	Value
Controller	replay
Target scopes	chart
Family	replay
Implementation	sdk
Permission label	replay.control
Financial risk classes	None
Decision receipt	None
Input constraints	replay.startPicking.allowedSymbols result filter · symbols
Revision domains	replay, viewport
Options index	None

Public SDK signature

() => ReplayState

replay.stepBackwardwrite · write

Moves the replay cursor back by count bars (default 1) and returns the updated state.

Contract	Value
Controller	replay
Target scopes	chart
Family	replay
Implementation	sdk
Permission label	replay.control
Financial risk classes	None
Decision receipt	None
Input constraints	replay.stepBackward.allowedSymbols result filter · symbols
Revision domains	replay, viewport
Options index	None

Public SDK signature

(count?: number) => ReplayState

replay.stepForwardwrite · write

Advances the replay cursor by count bars (default 1) and returns the updated state.

Contract	Value
Controller	replay
Target scopes	chart
Family	replay
Implementation	sdk
Permission label	replay.control
Financial risk classes	None
Decision receipt	None
Input constraints	replay.stepForward.allowedSymbols result filter · symbols
Revision domains	replay, viewport
Options index	None

Public SDK signature

(count?: number) => ReplayState

risk.engageKillSwitchtrade · financial

Engages the emergency kill switch so every subsequent evaluation is rejected with
emergency.kill-switch-engaged; a no-op returning the current state when already engaged.

Contract	Value
Controller	risk
Target scopes	session
Family	emergency
Implementation	sdk
Permission label	risk.emergency
Financial risk classes	emergency-risk-reducing
Decision receipt	never
Input constraints	None
Revision domains	risk
Options index	None

Public SDK signature

engageKillSwitch(action: RiskEmergencyAction): RiskEmergencyState

risk.evaluatewrite · write

Validates a decision request and evaluates it against the kill switch, effective scopes, limits,
host utilization, and the autonomy disposition, recording an immutable receipt, publishing a
'decision' event, and notifying decision listeners. Duplicate decision ids throw a
risk.duplicate-decision error.

Contract	Value
Controller	risk
Target scopes	session
Family	riskPolicy
Implementation	sdk
Permission label	risk.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · risk.evaluate.symbols authority extractor · required when constrained accounts · string · risk.evaluate.accounts authority extractor · required when constrained resourceIds · string · risk.evaluate.resourceIds authority extractor · required when constrained resourceKinds · string · risk.evaluate.resourceKinds authority extractor · required when constrained orderTypes · string · risk.evaluate.orderTypes authority extractor · optional when constrained orderSides · string · risk.evaluate.orderSides authority extractor · optional when constrained timeInForce · string · risk.evaluate.timeInForce authority extractor · optional when constrained positionIds · string · risk.evaluate.positionIds authority extractor · optional when constrained maxQuantity · finite-number · risk.evaluate.maxQuantity authority extractor · optional when constrained; absolute magnitude maxNotional · finite-number · risk.evaluate.maxNotional authority extractor · optional when constrained; absolute magnitude maxLeverage · finite-number · risk.evaluate.maxLeverage authority extractor · optional when constrained; absolute magnitude maxPositionQuantity · finite-number · risk.evaluate.maxPositionQuantity authority extractor · optional when constrained; absolute magnitude maxPositionNotional · finite-number · risk.evaluate.maxPositionNotional authority extractor · optional when constrained; absolute magnitude maxDailyLoss · finite-number · risk.evaluate.maxDailyLoss authority extractor · required when constrained; absolute magnitude maxSlippageBps · finite-number · risk.evaluate.maxSlippageBps authority extractor · optional when constrained; absolute magnitude maxOrdersPerMinute · finite-number · risk.evaluate.maxOrdersPerMinute authority extractor · optional when constrained; absolute magnitude maxMarketDataAgeMs · finite-number · risk.evaluate.maxMarketDataAgeMs authority extractor · optional when constrained; absolute magnitude risk.evaluate.allowedSymbolsAccounts result filter · symbols, accounts
Revision domains	risk
Options index	None

Public SDK signature

evaluate(request: RiskDecisionRequest): RiskDecisionReceipt

risk.getAutonomyModeread · read

Returns the effective policy's autonomy mode, which decides whether otherwise-allowed requests
execute, require approval, or are rejected.

Contract	Value
Controller	risk
Target scopes	session
Family	risk
Implementation	sdk
Permission label	risk.read
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	None
Options index	None

Public SDK signature

getAutonomyMode(): RiskAutonomyMode

risk.getCurrentUtilizationread · read

Returns the latest validated utilization snapshot relayed from the host utilization source.

Contract	Value
Controller	risk
Target scopes	session
Family	risk
Implementation	sdk
Permission label	risk.read
Financial risk classes	None
Decision receipt	None
Input constraints	risk.getCurrentUtilization.allowedSymbolsAccounts result filter · symbols, accounts
Revision domains	None
Options index	None

Public SDK signature

getCurrentUtilization(): RiskPolicyUtilization

risk.getDecisionReceiptread · read

Looks up a previously issued decision receipt by its immutable decision id.

Contract	Value
Controller	risk
Target scopes	session
Family	risk
Implementation	sdk
Permission label	risk.read
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · risk.getDecisionReceipt.resourceIds authority extractor · required when constrained resourceKinds · string · risk.getDecisionReceipt.resourceKinds authority extractor · required when constrained risk.getDecisionReceipt.allowedSymbolsAccounts result filter · symbols, accounts risk.getDecisionReceipt.allowedResources result filter · resourceIds, resourceKinds risk.getDecisionReceipt.tradePolicy result filter · orderTypes, orderSides, timeInForce, positionIds, maxQuantity, maxNotional, maxLeverage, maxPositionQuantity, maxPositionNotional, maxDailyLoss, maxSlippageBps, maxOrdersPerMinute, maxMarketDataAgeMs
Revision domains	None
Options index	None

Public SDK signature

getDecisionReceipt(decisionId: string): RiskDecisionReceipt | null

risk.getDecisionReceiptsread · read

Queries the bounded in-memory receipt window, optionally starting after a known sequence number.

Contract	Value
Controller	risk
Target scopes	session
Family	risk
Implementation	sdk
Permission label	risk.read
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · risk.getDecisionReceipts.resourceIds authority extractor · required when constrained resourceKinds · string · risk.getDecisionReceipts.resourceKinds authority extractor · required when constrained risk.getDecisionReceipts.allowedSymbolsAccounts result filter · symbols, accounts risk.getDecisionReceipts.allowedResources result filter · resourceIds, resourceKinds risk.getDecisionReceipts.tradePolicy result filter · orderTypes, orderSides, timeInForce, positionIds, maxQuantity, maxNotional, maxLeverage, maxPositionQuantity, maxPositionNotional, maxDailyLoss, maxSlippageBps, maxOrdersPerMinute, maxMarketDataAgeMs
Revision domains	None
Options index	None

Public SDK signature

getDecisionReceipts(query?: RiskDecisionReceiptQuery): readonly RiskDecisionReceipt[]

risk.getEffectivePolicyread · read

Returns the currently effective policy envelope — the host policy after any narrowPolicy calls
— which evaluate decides against.

Contract	Value
Controller	risk
Target scopes	session
Family	risk
Implementation	sdk
Permission label	risk.read
Financial risk classes	None
Decision receipt	None
Input constraints	risk.getEffectivePolicy.allowedSymbolsAccounts result filter · symbols, accounts risk.getEffectivePolicy.tradePolicy result filter · orderTypes, orderSides, timeInForce, positionIds, maxQuantity, maxNotional, maxLeverage, maxPositionQuantity, maxPositionNotional, maxDailyLoss, maxSlippageBps, maxOrdersPerMinute, maxMarketDataAgeMs
Revision domains	None
Options index	None

Public SDK signature

getEffectivePolicy(): RiskPolicyEnvelope

risk.getEmergencyStateread · read

Returns the current kill-switch state, including whether it is engaged and who last changed it.

Contract	Value
Controller	risk
Target scopes	session
Family	risk
Implementation	sdk
Permission label	risk.read
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	None
Options index	None

Public SDK signature

getEmergencyState(): RiskEmergencyState

risk.getHostPolicyread · read

Returns the original host-authored policy envelope, which never changes over the controller's
lifetime regardless of later narrowing.

Contract	Value
Controller	risk
Target scopes	session
Family	risk
Implementation	sdk
Permission label	risk.read
Financial risk classes	None
Decision receipt	None
Input constraints	risk.getHostPolicy.allowedSymbolsAccounts result filter · symbols, accounts risk.getHostPolicy.tradePolicy result filter · orderTypes, orderSides, timeInForce, positionIds, maxQuantity, maxNotional, maxLeverage, maxPositionQuantity, maxPositionNotional, maxDailyLoss, maxSlippageBps, maxOrdersPerMinute, maxMarketDataAgeMs
Revision domains	None
Options index	None

Public SDK signature

getHostPolicy(): RiskPolicyEnvelope

risk.getStateread · read

Returns a frozen snapshot of the full controller state: policy version, host and effective
policies, utilization, emergency state, decision count, and the recent receipt window.

Contract	Value
Controller	risk
Target scopes	session
Family	risk
Implementation	sdk
Permission label	risk.read
Financial risk classes	None
Decision receipt	None
Input constraints	risk.getState.allowedSymbolsAccounts result filter · symbols, accounts risk.getState.allowedResources result filter · resourceIds, resourceKinds risk.getState.tradePolicy result filter · orderTypes, orderSides, timeInForce, positionIds, maxQuantity, maxNotional, maxLeverage, maxPositionQuantity, maxPositionNotional, maxDailyLoss, maxSlippageBps, maxOrdersPerMinute, maxMarketDataAgeMs
Revision domains	None
Options index	None

Public SDK signature

getState(): RiskPolicyState

risk.narrowPolicywrite · write

Replaces the effective policy with a strictly narrower envelope — subset scopes, lower-or-equal
limits, and no higher autonomy level — bumping the policy version and publishing a
'policy-narrowed' event. Any widening throws a risk.policy-widening error.

Contract	Value
Controller	risk
Target scopes	session
Family	riskPolicy
Implementation	sdk
Permission label	risk.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · risk.narrowPolicy.symbols authority extractor · required when constrained accounts · string · risk.narrowPolicy.accounts authority extractor · required when constrained orderTypes · string · risk.narrowPolicy.orderTypes authority extractor · required when constrained orderSides · string · risk.narrowPolicy.orderSides authority extractor · required when constrained maxQuantity · finite-number · args[0].limits.maxOrderQuantity · required when constrained; absolute magnitude maxNotional · finite-number · args[0].limits.maxOrderNotional · required when constrained; absolute magnitude maxLeverage · finite-number · args[0].limits.maxLeverage · required when constrained; absolute magnitude maxPositionQuantity · finite-number · args[0].limits.maxPositionQuantity · required when constrained; absolute magnitude maxPositionNotional · finite-number · args[0].limits.maxPositionNotional · required when constrained; absolute magnitude maxDailyLoss · finite-number · args[0].limits.maxDailyLoss · required when constrained; absolute magnitude maxSlippageBps · finite-number · args[0].limits.maxEstimatedSlippageBps · required when constrained; absolute magnitude maxOrdersPerMinute · finite-number · args[0].limits.maxOrdersPerMinute · required when constrained; absolute magnitude maxMarketDataAgeMs · finite-number · args[0].limits.maxMarketDataAgeMs · required when constrained; absolute magnitude risk.narrowPolicy.allowedSymbolsAccounts result filter · symbols, accounts risk.narrowPolicy.tradePolicy result filter · orderTypes, orderSides, timeInForce, positionIds, maxQuantity, maxNotional, maxLeverage, maxPositionQuantity, maxPositionNotional, maxDailyLoss, maxSlippageBps, maxOrdersPerMinute, maxMarketDataAgeMs
Revision domains	risk
Options index	None

Public SDK signature

narrowPolicy(policy: RiskPolicyEnvelope): RiskPolicyState

symbolLink.getStateread · read

Returns a snapshot of the controller's current state, with the symbol and member entries
defensively copied.

Contract	Value
Controller	symbolLink
Target scopes	session, widget
Family	chartNavigation
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	symbolLink.getState.allowedSymbols result filter · symbols
Revision domains	None
Options index	None

Public SDK signature

getState(): SymbolLinkControllerState

symbolLink.getSymbolread · read

Returns the group's current symbol, or undefined before an initial selection is made.

Contract	Value
Controller	symbolLink
Target scopes	session, widget
Family	chartNavigation
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	symbolLink.getSymbol.allowedSymbols result filter · symbols
Revision domains	None
Options index	None

Public SDK signature

() => SdkSymbolInfo | undefined

symbolLink.listMembersread · read

Lists the currently registered chart and widget members.

Contract	Value
Controller	symbolLink
Target scopes	session, widget
Family	chartNavigation
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	None
Options index	None

Public SDK signature

listMembers(): readonly SymbolLinkMember[]

symbolLink.setSymbolwrite · write

Selects a symbol and notifies subscribers when its canonical identity changes.

Contract	Value
Controller	symbolLink
Target scopes	session, widget
Family	symbolLink
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · symbolLink.setSymbol.symbols authority extractor · required when constrained
Revision domains	data
Options index	None

Public SDK signature

(symbol: SdkSymbolInfo | string) => void

timeAndSales.clearwrite · write

TimeAndSalesControllerApi.clear

Contract	Value
Controller	timeAndSales
Target scopes	widget
Family	orderFlow
Implementation	sdk
Permission label	marketdata.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · timeAndSales.current.symbols authority extractor · required when constrained
Revision domains	orderFlow
Options index	None

Public SDK signature

clear(): void

timeAndSales.getSnapshotread · read

TimeAndSalesControllerApi.getSnapshot

Contract	Value
Controller	timeAndSales
Target scopes	widget
Family	orderFlow
Implementation	sdk
Permission label	marketdata.read
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · tape catalog literal · required when constrained timeAndSales.getSnapshot.dataProjection result filter · dataFields, maxRows, maxHistoryLookbackMs, maxMarketDataAgeMs timeAndSales.getSnapshot.allowedSymbols result filter · symbols
Revision domains	None
Options index	None

Public SDK signature

getSnapshot(): TimeAndSalesSnapshot

timeAndSales.setFilterswrite · write

TimeAndSalesControllerApi.setFilters

Contract	Value
Controller	timeAndSales
Target scopes	widget
Family	orderFlow
Implementation	sdk
Permission label	marketdata.write
Financial risk classes	None
Decision receipt	None
Input constraints	maxRows · finite-number · args[0].maxRows · required when constrained; signed value symbols · string · timeAndSales.current.symbols authority extractor · required when constrained
Revision domains	orderFlow
Options index	None

Public SDK signature

setFilters(filters: TimeAndSalesFilters): void

timeAndSales.setPausedwrite · write

TimeAndSalesControllerApi.setPaused

Contract	Value
Controller	timeAndSales
Target scopes	widget
Family	orderFlow
Implementation	sdk
Permission label	marketdata.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · timeAndSales.current.symbols authority extractor · required when constrained
Revision domains	orderFlow
Options index	None

Public SDK signature

setPaused(paused: boolean): void

timeAndSales.setSymbolwrite · write

TimeAndSalesControllerApi.setSymbol

Contract	Value
Controller	timeAndSales
Target scopes	widget
Family	orderFlow
Implementation	sdk
Permission label	marketdata.write
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · tape catalog literal · required when constrained symbols · string · timeAndSales.setSymbol.symbols authority extractor · required when constrained
Revision domains	orderFlow
Options index	None

Public SDK signature

setSymbol(symbol: SdkSymbolInfo): Promise<void>

timeScale.barSpacingread · read

Current bar spacing in CSS pixels.

Contract	Value
Controller	timeScale
Target scopes	chart
Family	chartNavigation
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	None
Options index	None

Public SDK signature

() => number

timeScale.defaultRightOffsetread · read

Default right offset in bars for the current spacing.

Contract	Value
Controller	timeScale
Target scopes	chart
Family	chartNavigation
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	None
Options index	None

Public SDK signature

() => number

timeScale.inactivityGapsread · read

Whether the chart preserves inactivity gaps when empty bars are present in the time domain.

Contract	Value
Controller	timeScale
Target scopes	chart
Family	chartNavigation
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	None
Options index	None

Public SDK signature

() => boolean

timeScale.rightOffsetread · read

Current right offset in bars.

Contract	Value
Controller	timeScale
Target scopes	chart
Family	chartNavigation
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	None
Options index	None

Public SDK signature

() => number

timeScale.setBarSpacingwrite · write

Set bar spacing in CSS pixels; a smaller value zooms out and a larger value zooms in.

Contract	Value
Controller	timeScale
Target scopes	chart
Family	chartNavigation
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	viewport
Options index	None

Public SDK signature

(value: number, options?: UndoOptions) => Promise<void> | void

timeScale.setInactivityGapswrite · write

Set inactivity-gap display policy. Hosts should reload data when this changes empty-bar generation.

Contract	Value
Controller	timeScale
Target scopes	chart
Family	chartNavigation
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	viewport
Options index	None

Public SDK signature

(value: boolean, options?: UndoOptions) => Promise<void> | void

timeScale.setRightOffsetwrite · write

Set right offset in bars.

Contract	Value
Controller	timeScale
Target scopes	chart
Family	chartNavigation
Implementation	sdk
Permission label	chart.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	viewport
Options index	None

Public SDK signature

(value: number, options?: UndoOptions) => Promise<void> | void

timeScale.widthread · read

Current time-scale plot width in CSS pixels.

Contract	Value
Controller	timeScale
Target scopes	chart
Family	chartNavigation
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	None
Options index	None

Public SDK signature

() => number

trading.cancelAllOrderstrade · financial

Atomic broker-owned cancellation of working orders, optionally scoped by account or symbol;
resolves the number of orders cancelled and is never reconstructed by the SDK as a list-and-loop
fallback.

Contract	Value
Controller	trading
Target scopes	session, chart
Family	emergency
Implementation	sdk
Permission label	trading.write
Financial risk classes	emergency-risk-reducing
Decision receipt	never
Input constraints	symbols · string · trading.cancelAllOrders.symbols authority extractor · required when constrained accounts · string · trading.cancelAllOrders.accounts authority extractor · required when constrained resourceIds · string · trading.cancelAllOrders.resourceIds authority extractor · required when constrained resourceKinds · string · trading.cancelAllOrders.resourceKinds authority extractor · required when constrained trading.cancelAllOrders.allowedSymbolsAccounts result filter · symbols, accounts
Revision domains	trading
Options index	0

Public SDK signature

(options?: TradingBulkActionOptions) => Promise<number>

trading.cancelOrdertrade · financial

Cancels a single working order.

Contract	Value
Controller	trading
Target scopes	session, chart
Family	orders
Implementation	sdk
Permission label	trading.write
Financial risk classes	risk-reducing
Decision receipt	never
Input constraints	symbols · string · trading.cancelOrder.symbols authority extractor · required when constrained accounts · string · trading.cancelOrder.accounts authority extractor · required when constrained resourceIds · string · trading.cancelOrder.resourceIds authority extractor · required when constrained resourceKinds · string · trading.cancelOrder.resourceKinds authority extractor · required when constrained
Revision domains	trading
Options index	2

Public SDK signature

(orderId: TradingOrderId, context: TradingOrderContext, options?: TradingFinancialMutationOptions) => Promise<void>

trading.cancelOrderstrade · financial

Cancels several working orders in one call.

Contract	Value
Controller	trading
Target scopes	session, chart
Family	emergency
Implementation	sdk
Permission label	trading.write
Financial risk classes	risk-reducing
Decision receipt	never
Input constraints	symbols · string · trading.cancelOrders.symbols authority extractor · required when constrained accounts · string · trading.cancelOrders.accounts authority extractor · required when constrained resourceIds · string · trading.cancelOrders.resourceIds authority extractor · required when constrained resourceKinds · string · trading.cancelOrders.resourceKinds authority extractor · required when constrained
Revision domains	trading
Options index	2

Public SDK signature

(orderIds: TradingOrderId[], context: TradingOrderContext, options?: TradingFinancialMutationOptions) => Promise<void>

trading.clearLogswrite · write

Clears the controller's diagnostic log buffer and emits a logs-cleared event.

Contract	Value
Controller	trading
Target scopes	session, chart
Family	tradingLogs
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	trading
Options index	None

Public SDK signature

() => void

trading.clearOrderDraftwrite · write

Close the open draft without submitting. Emits order-draft-clear.

Contract	Value
Controller	trading
Target scopes	session, chart
Family	orderEntry
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · trading.currentOrderDraft.symbols authority extractor · required when constrained accounts · string · trading.currentOrderDraft.accounts authority extractor · required when constrained resourceIds · string · trading.clearOrderDraft.resourceIds authority extractor · required when constrained resourceKinds · string · trading.clearOrderDraft.resourceKinds authority extractor · required when constrained
Revision domains	trading
Options index	None

Public SDK signature

() => void

trading.closeIndividualPositiontrade · financial

Closes one individual (non-netted) position; present only when the adapter supports it.

Contract	Value
Controller	trading
Target scopes	session, chart
Family	positions
Implementation	sdk
Permission label	trading.write
Financial risk classes	risk-reducing
Decision receipt	never
Input constraints	symbols · string · trading.closeIndividualPosition.symbols authority extractor · required when constrained accounts · string · trading.closeIndividualPosition.accounts authority extractor · required when constrained resourceIds · string · trading.closeIndividualPosition.resourceIds authority extractor · required when constrained resourceKinds · string · trading.closeIndividualPosition.resourceKinds authority extractor · required when constrained positionIds · string · args[0] · required when constrained
Revision domains	trading
Options index	2

Public SDK signature

(positionId: TradingPositionId, context: TradingOrderContext, options?: TradingPositionCloseOptions) => Promise<void>

trading.closePositiontrade · financial

Closes a net position, optionally partially via options.quantity.

Contract	Value
Controller	trading
Target scopes	session, chart
Family	positions
Implementation	sdk
Permission label	trading.write
Financial risk classes	risk-reducing
Decision receipt	never
Input constraints	symbols · string · trading.closePosition.symbols authority extractor · required when constrained accounts · string · trading.closePosition.accounts authority extractor · required when constrained resourceIds · string · trading.closePosition.resourceIds authority extractor · required when constrained resourceKinds · string · trading.closePosition.resourceKinds authority extractor · required when constrained positionIds · string · args[0] · required when constrained
Revision domains	trading
Options index	2

Public SDK signature

(positionId: TradingPositionId, context: TradingOrderContext, options?: TradingPositionCloseOptions) => Promise<void>

trading.connectwrite · write

Opens the broker session through the underlying adapter and resolves any connection info it
reports.

Contract	Value
Controller	trading
Target scopes	session, chart
Family	tradingSession
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	trading
Options index	None

Public SDK signature

() => Promise<TradingConnectionInfo | void>

trading.disconnectwrite · write

Closes the broker session.

Contract	Value
Controller	trading
Target scopes	session, chart
Family	tradingSession
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	trading
Options index	None

Public SDK signature

() => Promise<void>

trading.editIndividualPositionBracketstrade · financial

Edits the bracket orders attached to one individual position and resolves the updated individual
position; present only when the adapter supports it.

Contract	Value
Controller	trading
Target scopes	session, chart
Family	positions
Implementation	sdk
Permission label	trading.write
Financial risk classes	risk-changing
Decision receipt	always
Input constraints	symbols · string · trading.editIndividualPositionBrackets.symbols authority extractor · required when constrained accounts · string · trading.editIndividualPositionBrackets.accounts authority extractor · required when constrained resourceIds · string · trading.editIndividualPositionBrackets.resourceIds authority extractor · required when constrained resourceKinds · string · trading.editIndividualPositionBrackets.resourceKinds authority extractor · required when constrained positionIds · string · args[0] · required when constrained trading.editIndividualPositionBrackets.allowedSymbolsAccounts result filter · symbols, accounts trading.editIndividualPositionBrackets.tradePolicy result filter · positionIds, maxQuantity
Revision domains	trading
Options index	3

Public SDK signature

(positionId: TradingPositionId, patch: TradingPositionPatch, context: TradingOrderContext, options?: TradingFinancialMutationOptions) => Promise<TradingIndividualPosition>

trading.flattenPositionstrade · financial

Atomic broker-owned flatten of open positions where each supplied context carries the executable
quote for one symbol; resolves the number of positions flattened.

Contract	Value
Controller	trading
Target scopes	session, chart
Family	emergency
Implementation	sdk
Permission label	trading.write
Financial risk classes	emergency-risk-reducing
Decision receipt	never
Input constraints	symbols · string · trading.flattenPositions.symbols authority extractor · required when constrained accounts · string · trading.flattenPositions.accounts authority extractor · required when constrained resourceIds · string · trading.flattenPositions.resourceIds authority extractor · required when constrained resourceKinds · string · trading.flattenPositions.resourceKinds authority extractor · required when constrained trading.flattenPositions.allowedSymbolsAccounts result filter · symbols, accounts
Revision domains	trading
Options index	1

Public SDK signature

(contexts: TradingOrderContext[], options?: TradingBulkActionOptions) => Promise<number>

trading.getConnectionStatusread · read

Resolves the current broker connection status.

Contract	Value
Controller	trading
Target scopes	session, chart
Family	trading
Implementation	sdk
Permission label	trading.read
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	None
Options index	None

Public SDK signature

() => Promise<TradingConnectionStatus>

trading.getExecutionEnvironmentread · read

Carries the broker-owned environment fact without rediscovery.

Contract	Value
Controller	trading
Target scopes	session, chart
Family	trading
Implementation	sdk
Permission label	trading.read
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	None
Options index	None

Public SDK signature

() => TradingExecutionEnvironment | undefined

trading.getFeaturesread · read

Resolves the broker's runtime/account feature metadata.

Contract	Value
Controller	trading
Target scopes	session, chart
Family	trading
Implementation	sdk
Permission label	trading.read
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	None
Options index	None

Public SDK signature

() => Promise<TradingFeatureSet>

trading.getLogsread · read

Returns the controller's in-memory diagnostic log entries synchronously.

Contract	Value
Controller	trading
Target scopes	session, chart
Family	trading
Implementation	sdk
Permission label	trading.read
Financial risk classes	None
Decision receipt	None
Input constraints	trading.getLogs.allowedSymbolsAccounts result filter · symbols, accounts
Revision domains	None
Options index	None

Public SDK signature

() => TradingLogEntry[]

trading.getOperationSupportread · read

Exact synchronous structural support used by UI and agentic discovery.
The returned plain manifest is stable for the controller's registered lifetime.

Contract	Value
Controller	trading
Target scopes	session, chart
Family	trading
Implementation	sdk
Permission label	trading.read
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	None
Options index	None

Public SDK signature

() => TradingControllerOperationSupport

trading.getOrderDraftread · read

Current on-chart order draft, or null when none is open.

Contract	Value
Controller	trading
Target scopes	session, chart
Family	trading
Implementation	sdk
Permission label	trading.read
Financial risk classes	None
Decision receipt	None
Input constraints	trading.getOrderDraft.allowedSymbolsAccounts result filter · symbols, accounts trading.getOrderDraft.allowedResources result filter · resourceIds, resourceKinds trading.getOrderDraft.tradePolicy result filter · orderTypes, orderSides, timeInForce, maxQuantity
Revision domains	None
Options index	None

Public SDK signature

() => ChartOrderDraftState | null

trading.getOrdersHistoryread · read

Loads historical orders, optionally filtered by account, symbol, status, time range, limit, and
cursor.

Contract	Value
Controller	trading
Target scopes	session, chart
Family	trading
Implementation	sdk
Permission label	trading.read
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · trading.getOrdersHistory.symbols authority extractor · optional when constrained accounts · string · trading.getOrdersHistory.accounts authority extractor · optional when constrained resourceIds · string · trading.getOrdersHistory.resourceIds authority extractor · required when constrained resourceKinds · string · trading.getOrdersHistory.resourceKinds authority extractor · required when constrained trading.getOrdersHistory.allowedSymbolsAccounts result filter · symbols, accounts trading.getOrdersHistory.allowedResources result filter · resourceIds, resourceKinds trading.getOrdersHistory.tradePolicy result filter · orderTypes, orderSides, timeInForce, maxQuantity, positionIds
Revision domains	None
Options index	None

Public SDK signature

(request?: TradingOrdersHistoryRequest) => Promise<TradingOrder[]>

trading.getOrderTicketSettingsread · read

Reads persisted per-user order-ticket settings for the requested account/symbol scope; present
only when the adapter supports it.

Contract	Value
Controller	trading
Target scopes	session, chart
Family	trading
Implementation	sdk
Permission label	trading.read
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · trading.getOrderTicketSettings.symbols authority extractor · required when constrained accounts · string · trading.getOrderTicketSettings.accounts authority extractor · required when constrained resourceIds · string · trading.getOrderTicketSettings.resourceIds authority extractor · required when constrained resourceKinds · string · trading.getOrderTicketSettings.resourceKinds authority extractor · required when constrained trading.getOrderTicketSettings.allowedSymbolsAccounts result filter · symbols, accounts trading.getOrderTicketSettings.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

(request: TradingTicketSettingsRequest) => Promise<TradingTicketUserSettings | undefined>

trading.getStateread · read

Resolves a complete trading-state snapshot (accounts, orders, positions, executions, messages).

Contract	Value
Controller	trading
Target scopes	session, chart
Family	trading
Implementation	sdk
Permission label	trading.read
Financial risk classes	None
Decision receipt	None
Input constraints	trading.getState.allowedSymbolsAccounts result filter · symbols, accounts trading.getState.allowedResources result filter · resourceIds, resourceKinds trading.getState.tradePolicy result filter · orderTypes, orderSides, timeInForce, positionIds, maxQuantity, maxNotional, maxLeverage, maxPositionQuantity, maxPositionNotional, maxDailyLoss, maxSlippageBps, maxOrdersPerMinute, maxMarketDataAgeMs
Revision domains	None
Options index	None

Public SDK signature

() => Promise<TradingState>

trading.getSuggestedQuantityread · read

Reads the broker's remembered default order quantity for the requested scope; present only when
the adapter supports it.

Contract	Value
Controller	trading
Target scopes	session, chart
Family	trading
Implementation	sdk
Permission label	trading.read
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · trading.getSuggestedQuantity.symbols authority extractor · required when constrained accounts · string · trading.getSuggestedQuantity.accounts authority extractor · required when constrained trading.getSuggestedQuantity.allowedSymbolsAccounts result filter · symbols, accounts
Revision domains	None
Options index	None

Public SDK signature

(request: TradingSuggestedQuantityRequest) => Promise<number | undefined>

trading.getTradingSymbolInforead · read

Resolves the trading rules (quantity/price steps, supported order types, durations, bracket
support) for the context's symbol and account.

Contract	Value
Controller	trading
Target scopes	session, chart
Family	trading
Implementation	sdk
Permission label	trading.read
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · trading.getTradingSymbolInfo.symbols authority extractor · required when constrained accounts · string · trading.getTradingSymbolInfo.accounts authority extractor · required when constrained trading.getTradingSymbolInfo.allowedSymbolsAccounts result filter · symbols, accounts trading.getTradingSymbolInfo.tradePolicy result filter · orderTypes, timeInForce, maxQuantity, maxNotional
Revision domains	None
Options index	None

Public SDK signature

(context: TradingOrderContext) => Promise<TradingSymbolInfo>

trading.isTradableread · read

Reports whether the context's symbol is tradable, optionally with a reason, suggested solutions,
and symbol rules.

Contract	Value
Controller	trading
Target scopes	session, chart
Family	trading
Implementation	sdk
Permission label	trading.read
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · trading.isTradable.symbols authority extractor · required when constrained accounts · string · trading.isTradable.accounts authority extractor · required when constrained trading.isTradable.allowedSymbolsAccounts result filter · symbols, accounts
Revision domains	None
Options index	None

Public SDK signature

(context: TradingOrderContext) => Promise<TradingTradableResult>

trading.leverageInforead · read

Resolves the current leverage plus the allowed min/max/step range for a symbol, side, and
order-type route; present only when the adapter supports it.

Contract	Value
Controller	trading
Target scopes	session, chart
Family	trading
Implementation	sdk
Permission label	trading.read
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · trading.leverageInfo.symbols authority extractor · required when constrained accounts · string · trading.leverageInfo.accounts authority extractor · required when constrained orderTypes · string · args[0].orderType · required when constrained orderSides · string · args[0].side · required when constrained trading.leverageInfo.allowedSymbolsAccounts result filter · symbols, accounts
Revision domains	None
Options index	None

Public SDK signature

(request: TradingLeverageInfoParams) => Promise<TradingLeverageInfo>

trading.listAccountsread · read

Resolves the broker accounts available to the current session.

Contract	Value
Controller	trading
Target scopes	session, chart
Family	trading
Implementation	sdk
Permission label	trading.read
Financial risk classes	None
Decision receipt	None
Input constraints	trading.listAccounts.allowedAccounts result filter · accounts
Revision domains	None
Options index	None

Public SDK signature

() => Promise<TradingAccount[]>

trading.modifyOrdertrade · financial

Applies a patch to an existing order and resolves the updated order record.

Contract	Value
Controller	trading
Target scopes	session, chart
Family	orders
Implementation	sdk
Permission label	trading.write
Financial risk classes	risk-changing
Decision receipt	always
Input constraints	symbols · string · trading.modifyOrder.symbols authority extractor · required when constrained accounts · string · trading.modifyOrder.accounts authority extractor · required when constrained resourceIds · string · trading.modifyOrder.resourceIds authority extractor · required when constrained resourceKinds · string · trading.modifyOrder.resourceKinds authority extractor · required when constrained orderTypes · string · trading.modifyOrder.orderTypes authority extractor · required when constrained orderSides · string · trading.modifyOrder.orderSides authority extractor · required when constrained timeInForce · string · trading.modifyOrder.timeInForce authority extractor · required when constrained maxQuantity · finite-number · trading.modifyOrder.maxQuantity authority extractor · required when constrained; absolute magnitude trading.modifyOrder.allowedSymbolsAccounts result filter · symbols, accounts trading.modifyOrder.tradePolicy result filter · orderTypes, orderSides, timeInForce, maxQuantity
Revision domains	trading
Options index	3

Public SDK signature

(orderId: TradingOrderId, patch: TradingOrderPatch, context: TradingOrderContext, options?: TradingFinancialMutationOptions) => Promise<TradingOrder>

trading.modifyPositiontrade · financial

Applies a protection patch (stop-loss/take-profit brackets, guaranteed or trailing stops) to a
net position and resolves the updated position.

Contract	Value
Controller	trading
Target scopes	session, chart
Family	positions
Implementation	sdk
Permission label	trading.write
Financial risk classes	risk-changing
Decision receipt	always
Input constraints	symbols · string · trading.modifyPosition.symbols authority extractor · required when constrained accounts · string · trading.modifyPosition.accounts authority extractor · required when constrained resourceIds · string · trading.modifyPosition.resourceIds authority extractor · required when constrained resourceKinds · string · trading.modifyPosition.resourceKinds authority extractor · required when constrained positionIds · string · args[0] · required when constrained trading.modifyPosition.allowedSymbolsAccounts result filter · symbols, accounts trading.modifyPosition.tradePolicy result filter · positionIds, maxQuantity
Revision domains	trading
Options index	3

Public SDK signature

(positionId: TradingPositionId, patch: TradingPositionPatch, context: TradingOrderContext, options?: TradingFinancialMutationOptions) => Promise<TradingPosition>

trading.openOrderDraftwrite · write

Open (or replace) the shared on-chart order draft. Emits order-draft-open.

Contract	Value
Controller	trading
Target scopes	session, chart
Family	orderEntry
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · trading.openOrderDraft.symbols authority extractor · required when constrained accounts · string · trading.openOrderDraft.accounts authority extractor · required when constrained resourceIds · string · trading.openOrderDraft.resourceIds authority extractor · required when constrained resourceKinds · string · trading.openOrderDraft.resourceKinds authority extractor · required when constrained orderTypes · string · args[0].entryType · required when constrained orderSides · string · args[0].side · required when constrained maxQuantity · finite-number · args[0].quantity · required when constrained; absolute magnitude
Revision domains	trading
Options index	None

Public SDK signature

(draft: ChartOrderDraft, context: ChartOrderDraftContext) => void

trading.placeOrdertrade · financial

Submits an order draft to the broker and resolves its acceptance or rejection.

Contract	Value
Controller	trading
Target scopes	session, chart
Family	orders
Implementation	sdk
Permission label	trading.write
Financial risk classes	risk-increasing
Decision receipt	always
Input constraints	symbols · string · trading.placeOrder.symbols authority extractor · required when constrained accounts · string · trading.placeOrder.accounts authority extractor · required when constrained resourceIds · string · trading.placeOrder.resourceIds authority extractor · required when constrained resourceKinds · string · trading.placeOrder.resourceKinds authority extractor · required when constrained orderTypes · string · args[0].type · required when constrained orderSides · string · args[0].side · required when constrained timeInForce · string · args[0].duration.type · required when constrained maxQuantity · finite-number · args[0].quantity · required when constrained; absolute magnitude trading.placeOrder.allowedSymbolsAccounts result filter · symbols, accounts trading.placeOrder.tradePolicy result filter · orderTypes, orderSides, timeInForce, maxQuantity
Revision domains	trading
Options index	2

Public SDK signature

(draft: TradingOrderDraft, context: TradingOrderContext, options?: TradingFinancialMutationOptions) => Promise<TradingPlaceOrderResult>

trading.previewClosePositionread · read

Produces a broker preview for closing a position without executing the close.

Contract	Value
Controller	trading
Target scopes	session, chart
Family	tradingPreview
Implementation	sdk
Permission label	trading.read
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · trading.previewClosePosition.symbols authority extractor · required when constrained accounts · string · trading.previewClosePosition.accounts authority extractor · required when constrained resourceIds · string · trading.previewClosePosition.resourceIds authority extractor · required when constrained resourceKinds · string · trading.previewClosePosition.resourceKinds authority extractor · required when constrained positionIds · string · args[0] · required when constrained trading.previewClosePosition.allowedSymbolsAccounts result filter · symbols, accounts
Revision domains	None
Options index	None

Public SDK signature

(positionId: TradingPositionId, context: TradingOrderContext) => Promise<TradingPositionPreviewResult>

trading.previewLeverageread · read

Previews a leverage change, returning broker info, warning, and error messages without applying
it; present only when the adapter supports it.

Contract	Value
Controller	trading
Target scopes	session, chart
Family	tradingPreview
Implementation	sdk
Permission label	trading.read
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · trading.previewLeverage.symbols authority extractor · required when constrained accounts · string · trading.previewLeverage.accounts authority extractor · required when constrained orderTypes · string · args[0].orderType · required when constrained orderSides · string · args[0].side · required when constrained maxLeverage · finite-number · args[0].leverage · required when constrained; absolute magnitude trading.previewLeverage.allowedSymbolsAccounts result filter · symbols, accounts
Revision domains	None
Options index	None

Public SDK signature

(request: TradingLeverageSetParams) => Promise<TradingLeveragePreviewResult>

trading.previewModifyOrderread · read

Produces a broker preview for a pending patch to an existing order without applying it.

Contract	Value
Controller	trading
Target scopes	session, chart
Family	tradingPreview
Implementation	sdk
Permission label	trading.read
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · trading.previewModifyOrder.symbols authority extractor · required when constrained accounts · string · trading.previewModifyOrder.accounts authority extractor · required when constrained resourceIds · string · trading.previewModifyOrder.resourceIds authority extractor · required when constrained resourceKinds · string · trading.previewModifyOrder.resourceKinds authority extractor · required when constrained orderTypes · string · trading.previewModifyOrder.orderTypes authority extractor · required when constrained orderSides · string · trading.previewModifyOrder.orderSides authority extractor · required when constrained timeInForce · string · trading.previewModifyOrder.timeInForce authority extractor · required when constrained maxQuantity · finite-number · trading.previewModifyOrder.maxQuantity authority extractor · required when constrained; absolute magnitude trading.previewModifyOrder.allowedSymbolsAccounts result filter · symbols, accounts
Revision domains	None
Options index	None

Public SDK signature

(orderId: TradingOrderId, patch: TradingOrderPatch, context: TradingOrderContext) => Promise<TradingOrderPreviewResult>

trading.previewOrderread · read

Produces a broker preview (sections, estimated costs, warnings, confirmId) for an order draft
without placing it.

Contract	Value
Controller	trading
Target scopes	session, chart
Family	tradingPreview
Implementation	sdk
Permission label	trading.read
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · trading.previewOrder.symbols authority extractor · required when constrained accounts · string · trading.previewOrder.accounts authority extractor · required when constrained resourceIds · string · trading.previewOrder.resourceIds authority extractor · required when constrained resourceKinds · string · trading.previewOrder.resourceKinds authority extractor · required when constrained orderTypes · string · args[0].type · required when constrained orderSides · string · args[0].side · required when constrained timeInForce · string · args[0].duration.type · required when constrained maxQuantity · finite-number · args[0].quantity · required when constrained; absolute magnitude trading.previewOrder.allowedSymbolsAccounts result filter · symbols, accounts
Revision domains	None
Options index	None

Public SDK signature

(draft: TradingOrderDraft, context: TradingOrderContext) => Promise<TradingOrderPreviewResult>

trading.resolveOptionContractread · read

Resolves and validates one exact option contract through the broker's contract authority.

Contract	Value
Controller	trading
Target scopes	session, chart
Family	trading
Implementation	sdk
Permission label	trading.read
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · trading.resolveOptionContract.symbols authority extractor · required when constrained accounts · string · trading.resolveOptionContract.accounts authority extractor · required when constrained resourceIds · string · trading.resolveOptionContract.resourceIds authority extractor · required when constrained resourceKinds · string · trading.resolveOptionContract.resourceKinds authority extractor · required when constrained trading.resolveOptionContract.allowedSymbolsAccounts result filter · symbols, accounts trading.resolveOptionContract.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

(request: TradingResolveOptionContractRequest) => Promise<TradingOptionContractResolution>

trading.reversePositiontrade · financial

Reverses a position's direction at the broker; present only when the adapter supports it.

Contract	Value
Controller	trading
Target scopes	session, chart
Family	positions
Implementation	sdk
Permission label	trading.write
Financial risk classes	risk-changing
Decision receipt	always
Input constraints	symbols · string · trading.reversePosition.symbols authority extractor · required when constrained accounts · string · trading.reversePosition.accounts authority extractor · required when constrained resourceIds · string · trading.reversePosition.resourceIds authority extractor · required when constrained resourceKinds · string · trading.reversePosition.resourceKinds authority extractor · required when constrained positionIds · string · args[0] · required when constrained
Revision domains	trading
Options index	2

Public SDK signature

(positionId: TradingPositionId, context: TradingOrderContext, options?: TradingPositionReverseOptions) => Promise<void>

trading.setActiveAccountwrite · write

Switches the broker's active account to the given account id.

Contract	Value
Controller	trading
Target scopes	session, chart
Family	account
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	accounts · string · trading.setActiveAccount.accounts authority extractor · required when constrained
Revision domains	trading
Options index	None

Public SDK signature

(accountId: TradingAccountId) => Promise<void>

trading.setLeveragetrade · financial

Applies a leverage change at the broker; a financial mutation that accepts guarded agentic
identity options.

Contract	Value
Controller	trading
Target scopes	session, chart
Family	leverage
Implementation	sdk
Permission label	trading.write
Financial risk classes	risk-increasing
Decision receipt	always
Input constraints	symbols · string · trading.setLeverage.symbols authority extractor · required when constrained accounts · string · trading.setLeverage.accounts authority extractor · required when constrained orderTypes · string · args[0].orderType · required when constrained orderSides · string · args[0].side · required when constrained maxLeverage · finite-number · args[0].leverage · required when constrained; absolute magnitude trading.setLeverage.allowedSymbolsAccounts result filter · symbols, accounts
Revision domains	trading
Options index	1

Public SDK signature

(request: TradingLeverageSetParams, options?: TradingFinancialMutationOptions) => Promise<TradingLeverageSetResult>

trading.setOrderTicketSettingswrite · write

Persists user-changed order-ticket settings for the requested account/symbol scope; present only
when the adapter supports it.

Contract	Value
Controller	trading
Target scopes	session, chart
Family	orderEntry
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · trading.setOrderTicketSettings.symbols authority extractor · required when constrained accounts · string · trading.setOrderTicketSettings.accounts authority extractor · required when constrained resourceIds · string · trading.setOrderTicketSettings.resourceIds authority extractor · required when constrained resourceKinds · string · trading.setOrderTicketSettings.resourceKinds authority extractor · required when constrained
Revision domains	trading
Options index	None

Public SDK signature

(settings: TradingTicketUserSettings, request: TradingTicketSettingsRequest) => Promise<void>

trading.setSuggestedQuantitywrite · write

Persists the user's preferred default order quantity for the requested scope; present only when
the adapter supports it.

Contract	Value
Controller	trading
Target scopes	session, chart
Family	orderEntry
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · trading.setSuggestedQuantity.symbols authority extractor · required when constrained accounts · string · trading.setSuggestedQuantity.accounts authority extractor · required when constrained
Revision domains	trading
Options index	None

Public SDK signature

(quantity: number, request: TradingSuggestedQuantityRequest) => Promise<void>

trading.submitOrderDrafttrade · financial

Validate and submit the open draft as a bracket order via placeOrder.
On success the draft is cleared; on failure the draft stays open with an
error message. Resolves undefined when nothing was submitted.

Contract	Value
Controller	trading
Target scopes	session, chart
Family	orders
Implementation	sdk
Permission label	trading.write
Financial risk classes	risk-increasing
Decision receipt	always
Input constraints	symbols · string · trading.currentOrderDraft.symbols authority extractor · required when constrained accounts · string · trading.currentOrderDraft.accounts authority extractor · required when constrained resourceIds · string · trading.submitOrderDraft.resourceIds authority extractor · required when constrained resourceKinds · string · trading.submitOrderDraft.resourceKinds authority extractor · required when constrained trading.submitOrderDraft.allowedSymbolsAccounts result filter · symbols, accounts
Revision domains	trading
Options index	0

Public SDK signature

(options?: TradingFinancialMutationOptions) => Promise<TradingPlaceOrderResult | undefined>

trading.supportsOrderCancellationread · read

True when the underlying broker implements single-order cancellation.

Contract	Value
Controller	trading
Target scopes	session, chart
Family	trading
Implementation	sdk
Permission label	trading.read
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	None
Options index	None

Public SDK signature

() => boolean

trading.supportsOrderModificationread · read

True when the underlying broker implements order modification.

Contract	Value
Controller	trading
Target scopes	session, chart
Family	trading
Implementation	sdk
Permission label	trading.read
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	None
Options index	None

Public SDK signature

() => boolean

trading.updateOrderDraftwrite · write

Patch the open draft; clears any prior message. Emits order-draft-change.

Contract	Value
Controller	trading
Target scopes	session, chart
Family	orderEntry
Implementation	sdk
Permission label	trading.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · trading.currentOrderDraft.symbols authority extractor · required when constrained accounts · string · trading.currentOrderDraft.accounts authority extractor · required when constrained resourceIds · string · trading.updateOrderDraft.resourceIds authority extractor · required when constrained resourceKinds · string · trading.updateOrderDraft.resourceKinds authority extractor · required when constrained orderTypes · string · trading.updateOrderDraft.orderTypes authority extractor · required when constrained orderSides · string · trading.updateOrderDraft.orderSides authority extractor · required when constrained maxQuantity · finite-number · trading.updateOrderDraft.maxQuantity authority extractor · required when constrained; absolute magnitude
Revision domains	trading
Options index	None

Public SDK signature

(patch: Partial<ChartOrderDraft>) => void

watchlist.addSymbolwrite · write

WatchlistController.addSymbol

Contract	Value
Controller	watchlist
Target scopes	widget
Family	watchlists
Implementation	sdk
Permission label	marketdata.write
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · watchlists catalog literal · required when constrained symbols · string · watchlist.symbol.symbols authority extractor · required when constrained resourceIds · string · watchlist.addSymbol.resourceIds authority extractor · required when constrained resourceKinds · string · watchlist.addSymbol.resourceKinds authority extractor · required when constrained
Revision domains	watchlist
Options index	None

Public SDK signature

addSymbol(ticker: string, options?: WatchlistMutationOptions): Promise<boolean | void>

watchlist.createListwrite · write

WatchlistController.createList

Contract	Value
Controller	watchlist
Target scopes	widget
Family	watchlists
Implementation	sdk
Permission label	marketdata.write
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · watchlists catalog literal · required when constrained resourceIds · string · watchlist.createList.resourceIds authority extractor · required when constrained resourceKinds · string · watchlist.createList.resourceKinds authority extractor · required when constrained
Revision domains	watchlist
Options index	None

Public SDK signature

createList(name: string, options?: WatchlistMutationOptions): Promise<WatchlistListSummary | void>

watchlist.createSectionwrite · write

WatchlistController.createSection

Contract	Value
Controller	watchlist
Target scopes	widget
Family	watchlists
Implementation	sdk
Permission label	marketdata.write
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · watchlists catalog literal · required when constrained resourceIds · string · watchlist.createSection.resourceIds authority extractor · required when constrained resourceKinds · string · watchlist.createSection.resourceKinds authority extractor · required when constrained
Revision domains	watchlist
Options index	None

Public SDK signature

createSection(name: string, tickers: string[], options?: WatchlistMutationOptions): Promise<void>

watchlist.createShareLinkwrite · write

WatchlistController.createShareLink

Contract	Value
Controller	watchlist
Target scopes	widget
Family	watchlists
Implementation	sdk
Permission label	marketdata.write
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · watchlist.createShareLink.resourceIds authority extractor · required when constrained resourceKinds · string · watchlist.createShareLink.resourceKinds authority extractor · required when constrained
Revision domains	watchlist
Options index	None

Public SDK signature

createShareLink(
    listId: string,
    shareOptions?: { includeNotes?: boolean },
    options?: WatchlistMutationOptions,
  ): Promise<WatchlistShareLink>

watchlist.deleteListwrite · write

WatchlistController.deleteList

Contract	Value
Controller	watchlist
Target scopes	widget
Family	watchlists
Implementation	sdk
Permission label	marketdata.write
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · watchlists catalog literal · required when constrained resourceIds · string · watchlist.deleteList.resourceIds authority extractor · required when constrained resourceKinds · string · watchlist.deleteList.resourceKinds authority extractor · required when constrained
Revision domains	watchlist
Options index	None

Public SDK signature

deleteList(id: string, options?: WatchlistMutationOptions): Promise<void>

watchlist.deleteSectionwrite · write

WatchlistController.deleteSection

Contract	Value
Controller	watchlist
Target scopes	widget
Family	watchlists
Implementation	sdk
Permission label	marketdata.write
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · watchlists catalog literal · required when constrained resourceIds · string · watchlist.deleteSection.resourceIds authority extractor · required when constrained resourceKinds · string · watchlist.deleteSection.resourceKinds authority extractor · required when constrained
Revision domains	watchlist
Options index	None

Public SDK signature

deleteSection(name: string, options?: WatchlistMutationOptions): Promise<void>

watchlist.exportActiveListread · read

WatchlistController.exportActiveList

Contract	Value
Controller	watchlist
Target scopes	widget
Family	watchlists
Implementation	sdk
Permission label	marketdata.read
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · watchlists catalog literal · required when constrained resourceIds · string · watchlist.exportActiveList.resourceIds authority extractor · required when constrained resourceKinds · string · watchlist.exportActiveList.resourceKinds authority extractor · required when constrained watchlist.exportActiveList.allowedSymbols result filter · symbols watchlist.exportActiveList.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

exportActiveList(): WatchlistExport | null

watchlist.getLinkedSymbolread · read

WatchlistController.getLinkedSymbol

Contract	Value
Controller	watchlist
Target scopes	widget
Family	watchlist
Implementation	sdk
Permission label	marketdata.read
Financial risk classes	None
Decision receipt	None
Input constraints	watchlist.getLinkedSymbol.allowedSymbols result filter · symbols
Revision domains	None
Options index	None

Public SDK signature

getLinkedSymbol(): string | null

watchlist.getListsread · read

WatchlistController.getLists

Contract	Value
Controller	watchlist
Target scopes	widget
Family	watchlists
Implementation	sdk
Permission label	marketdata.read
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · watchlists catalog literal · required when constrained watchlist.getLists.dataProjection result filter · dataFields, maxRows watchlist.getLists.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

getLists(): WatchlistListSummary[]

watchlist.getSelectedListIdread · read

WatchlistController.getSelectedListId

Contract	Value
Controller	watchlist
Target scopes	widget
Family	watchlists
Implementation	sdk
Permission label	marketdata.read
Financial risk classes	None
Decision receipt	None
Input constraints	watchlist.getSelectedListId.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

getSelectedListId(): string | null

watchlist.getSnapshotread · read

WatchlistController.getSnapshot

Contract	Value
Controller	watchlist
Target scopes	widget
Family	watchlist
Implementation	sdk
Permission label	marketdata.read
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · watchlists catalog literal, l1 catalog literal · required when constrained watchlist.getSnapshot.dataProjection result filter · dataFields, maxRows watchlist.getSnapshot.allowedSymbols result filter · symbols watchlist.getSnapshot.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

getSnapshot(): WatchlistSnapshot

watchlist.getSymbolsread · read

WatchlistController.getSymbols

Contract	Value
Controller	watchlist
Target scopes	widget
Family	watchlist
Implementation	sdk
Permission label	marketdata.read
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · watchlists catalog literal · required when constrained watchlist.getSymbols.dataProjection result filter · dataFields, maxRows watchlist.getSymbols.allowedSymbols result filter · symbols watchlist.getSymbols.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

getSymbols(): WatchlistSymbol[]

watchlist.isReadyread · read

WatchlistController.isReady

Contract	Value
Controller	watchlist
Target scopes	widget
Family	watchlist
Implementation	sdk
Permission label	marketdata.read
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	None
Options index	None

Public SDK signature

isReady(): boolean

watchlist.moveSectionwrite · write

WatchlistController.moveSection

Contract	Value
Controller	watchlist
Target scopes	widget
Family	watchlists
Implementation	sdk
Permission label	marketdata.write
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · watchlists catalog literal · required when constrained resourceIds · string · watchlist.moveSection.resourceIds authority extractor · required when constrained resourceKinds · string · watchlist.moveSection.resourceKinds authority extractor · required when constrained
Revision domains	watchlist
Options index	None

Public SDK signature

moveSection(name: string, direction: 'up' | 'down', options?: WatchlistMutationOptions): Promise<void>

watchlist.moveSymbolToListwrite · write

WatchlistController.moveSymbolToList

Contract	Value
Controller	watchlist
Target scopes	widget
Family	watchlists
Implementation	sdk
Permission label	marketdata.write
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · watchlists catalog literal · required when constrained symbols · string · watchlist.symbol.symbols authority extractor · required when constrained resourceIds · string · watchlist.moveSymbolToList.resourceIds authority extractor · required when constrained resourceKinds · string · watchlist.moveSymbolToList.resourceKinds authority extractor · required when constrained
Revision domains	watchlist
Options index	None

Public SDK signature

moveSymbolToList(ticker: string, targetListId: string, options?: WatchlistMutationOptions): Promise<boolean | void>

watchlist.refreshwrite · write

WatchlistController.refresh

Contract	Value
Controller	watchlist
Target scopes	widget
Family	watchlists
Implementation	sdk
Permission label	marketdata.write
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · watchlists catalog literal, l1 catalog literal · required when constrained resourceIds · string · watchlist.refresh.resourceConstraintUnavailable authority extractor · required when constrained resourceKinds · string · watchlist.refresh.resourceConstraintUnavailable authority extractor · required when constrained
Revision domains	watchlist
Options index	None

Public SDK signature

refresh(options?: WatchlistMutationOptions): Promise<void>

watchlist.removeSymbolwrite · write

WatchlistController.removeSymbol

Contract	Value
Controller	watchlist
Target scopes	widget
Family	watchlists
Implementation	sdk
Permission label	marketdata.write
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · watchlists catalog literal · required when constrained symbols · string · watchlist.symbol.symbols authority extractor · required when constrained resourceIds · string · watchlist.removeSymbol.resourceIds authority extractor · required when constrained resourceKinds · string · watchlist.removeSymbol.resourceKinds authority extractor · required when constrained
Revision domains	watchlist
Options index	None

Public SDK signature

removeSymbol(ticker: string, options?: WatchlistMutationOptions): Promise<boolean | void>

watchlist.renameListwrite · write

WatchlistController.renameList

Contract	Value
Controller	watchlist
Target scopes	widget
Family	watchlists
Implementation	sdk
Permission label	marketdata.write
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · watchlists catalog literal · required when constrained resourceIds · string · watchlist.renameList.resourceIds authority extractor · required when constrained resourceKinds · string · watchlist.renameList.resourceKinds authority extractor · required when constrained
Revision domains	watchlist
Options index	None

Public SDK signature

renameList(id: string, name: string, options?: WatchlistMutationOptions): Promise<void>

watchlist.renameSectionwrite · write

WatchlistController.renameSection

Contract	Value
Controller	watchlist
Target scopes	widget
Family	watchlists
Implementation	sdk
Permission label	marketdata.write
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · watchlists catalog literal · required when constrained resourceIds · string · watchlist.renameSection.resourceIds authority extractor · required when constrained resourceKinds · string · watchlist.renameSection.resourceKinds authority extractor · required when constrained
Revision domains	watchlist
Options index	None

Public SDK signature

renameSection(name: string, nextName: string, options?: WatchlistMutationOptions): Promise<void>

watchlist.reorderSymbolswrite · write

WatchlistController.reorderSymbols

Contract	Value
Controller	watchlist
Target scopes	widget
Family	watchlists
Implementation	sdk
Permission label	marketdata.write
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · watchlists catalog literal · required when constrained symbols · string · watchlist.symbols.symbols authority extractor · required when constrained resourceIds · string · watchlist.reorderSymbols.resourceIds authority extractor · required when constrained resourceKinds · string · watchlist.reorderSymbols.resourceKinds authority extractor · required when constrained
Revision domains	watchlist
Options index	None

Public SDK signature

reorderSymbols(orderedTickers: string[], options?: WatchlistMutationOptions): Promise<boolean | void>

watchlist.selectListwrite · write

WatchlistController.selectList

Contract	Value
Controller	watchlist
Target scopes	widget
Family	watchlists
Implementation	sdk
Permission label	marketdata.write
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · watchlists catalog literal · required when constrained resourceIds · string · watchlist.selectList.resourceIds authority extractor · required when constrained resourceKinds · string · watchlist.selectList.resourceKinds authority extractor · required when constrained
Revision domains	watchlist
Options index	None

Public SDK signature

selectList(id: string, options?: WatchlistMutationOptions): Promise<void>

watchlist.selectSymbolwrite · write

WatchlistController.selectSymbol

Contract	Value
Controller	watchlist
Target scopes	widget
Family	watchlists
Implementation	sdk
Permission label	marketdata.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · watchlist.symbol.symbols authority extractor · required when constrained resourceIds · string · watchlist.selectSymbol.resourceIds authority extractor · required when constrained resourceKinds · string · watchlist.selectSymbol.resourceKinds authority extractor · required when constrained
Revision domains	watchlist
Options index	None

Public SDK signature

selectSymbol(symbol: string | WatchlistSymbol, options?: WatchlistMutationOptions): boolean

watchlist.setDensitywrite · write

WatchlistController.setDensity

Contract	Value
Controller	watchlist
Target scopes	widget
Family	watchlists
Implementation	sdk
Permission label	marketdata.write
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	watchlist
Options index	None

Public SDK signature

setDensity(density: WatchlistDensity, options?: WatchlistMutationOptions): boolean

watchlist.setSectionCollapsedwrite · write

WatchlistController.setSectionCollapsed

Contract	Value
Controller	watchlist
Target scopes	widget
Family	watchlists
Implementation	sdk
Permission label	marketdata.write
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · watchlist.setSectionCollapsed.resourceIds authority extractor · required when constrained resourceKinds · string · watchlist.setSectionCollapsed.resourceKinds authority extractor · required when constrained
Revision domains	watchlist
Options index	None

Public SDK signature

setSectionCollapsed(section: string, collapsed: boolean, options?: WatchlistMutationOptions): boolean

watchlist.setSelectedTickerswrite · write

WatchlistController.setSelectedTickers

Contract	Value
Controller	watchlist
Target scopes	widget
Family	watchlists
Implementation	sdk
Permission label	marketdata.write
Financial risk classes	None
Decision receipt	None
Input constraints	symbols · string · watchlist.symbols.symbols authority extractor · required when constrained resourceIds · string · watchlist.setSelectedTickers.resourceIds authority extractor · required when constrained resourceKinds · string · watchlist.setSelectedTickers.resourceKinds authority extractor · required when constrained
Revision domains	watchlist
Options index	None

Public SDK signature

setSelectedTickers(tickers: readonly string[], options?: WatchlistMutationOptions): boolean

watchlist.setSortwrite · write

WatchlistController.setSort

Contract	Value
Controller	watchlist
Target scopes	widget
Family	watchlists
Implementation	sdk
Permission label	marketdata.write
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	watchlist
Options index	None

Public SDK signature

setSort(sort: WatchlistSortPreference, options?: WatchlistMutationOptions): boolean

watchlist.setVisibleColumnswrite · write

WatchlistController.setVisibleColumns

Contract	Value
Controller	watchlist
Target scopes	widget
Family	watchlists
Implementation	sdk
Permission label	marketdata.write
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	watchlist
Options index	None

Public SDK signature

setVisibleColumns(columns: readonly WatchlistQuoteColumn[], options?: WatchlistMutationOptions): boolean

watchlist.toggleSectionwrite · write

WatchlistController.toggleSection

Contract	Value
Controller	watchlist
Target scopes	widget
Family	watchlists
Implementation	sdk
Permission label	marketdata.write
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · watchlist.toggleSection.resourceIds authority extractor · required when constrained resourceKinds · string · watchlist.toggleSection.resourceKinds authority extractor · required when constrained
Revision domains	watchlist
Options index	None

Public SDK signature

toggleSection(section: string, options?: WatchlistMutationOptions): boolean

watchlist.updateSymbolwrite · write

WatchlistController.updateSymbol

Contract	Value
Controller	watchlist
Target scopes	widget
Family	watchlists
Implementation	sdk
Permission label	marketdata.write
Financial risk classes	None
Decision receipt	None
Input constraints	dataDomains · string · watchlists catalog literal · required when constrained symbols · string · watchlist.symbol.symbols authority extractor · required when constrained resourceIds · string · watchlist.updateSymbol.resourceIds authority extractor · required when constrained resourceKinds · string · watchlist.updateSymbol.resourceKinds authority extractor · required when constrained
Revision domains	watchlist
Options index	None

Public SDK signature

updateSymbol(ticker: string, patch: WatchlistSymbolPatch, options?: WatchlistMutationOptions): Promise<boolean | void>

widget.describeCapabilitiesread · read

Describe widget mode, chart ids, and assembly-owned controller availability without probing accessors.

Contract	Value
Controller	widget
Target scopes	widget
Family	terminal
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	widget.describeCapabilities.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

() => Promise<ChartWidgetCapabilityDescription>

widget.getMaximizedChartIdread · read

Returns the id of the currently maximized chart, or undefined when no chart is maximized.

Contract	Value
Controller	widget
Target scopes	widget
Family	terminal
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	widget.getMaximizedChartId.allowedSymbols result filter · symbols widget.getMaximizedChartId.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

() => ChartId | undefined

widget.getRevisionSnapshotread · read

Return an identity-independent snapshot of the authoritative ten-domain revision ledger.

Contract	Value
Controller	widget
Target scopes	widget
Family	terminal
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	None
Options index	None

Public SDK signature

() => ChartRevisionSnapshot

widget.getWorkerStatusread · read

Read the widget-owned overlay and indicator worker lifecycle state.

Contract	Value
Controller	widget
Target scopes	widget
Family	terminal
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	widget.getWorkerStatus.allowedSymbols result filter · symbols
Revision domains	None
Options index	None

Public SDK signature

() => ChartWorkerStatus[]

widget.isChartMaximizedread · read

Whether the given chart is currently maximized; defaults to the active chart.

Contract	Value
Controller	widget
Target scopes	widget
Family	terminal
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · widget.isChartMaximized.resourceIds authority extractor · required when constrained resourceKinds · string · widget.isChartMaximized.resourceKinds authority extractor · required when constrained widget.isChartMaximized.allowedSymbols result filter · symbols
Revision domains	None
Options index	None

Public SDK signature

(chartId?: ChartId) => boolean

widget.maximizeChartwrite · write

Maximize one chart within a multi-chart workspace. Throws in single-chart mode.

Contract	Value
Controller	widget
Target scopes	widget
Family	terminalLayout
Implementation	sdk
Permission label	host.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · widget.maximizeChart.resourceIds authority extractor · required when constrained resourceKinds · string · widget.maximizeChart.resourceKinds authority extractor · required when constrained
Revision domains	layout
Options index	None

Public SDK signature

(chartId?: ChartId) => void

widget.resetCachewrite · write

Applies to every chart unless options.chartId scopes it.

Contract	Value
Controller	widget
Target scopes	widget
Family	chartNavigation
Implementation	sdk
Permission label	host.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	data
Options index	None

Public SDK signature

(options?: CacheResetOptions & { chartId?: ChartId }) => Promise<void>

widget.resetLayoutSizeswrite · write

Clear all persisted split weights back to equal sizing. Throws in single-chart mode.

Contract	Value
Controller	widget
Target scopes	widget
Family	terminalLayout
Implementation	sdk
Permission label	host.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · widget.resetLayoutSizes.resourceIds authority extractor · required when constrained resourceKinds · string · widget.resetLayoutSizes.resourceKinds authority extractor · required when constrained
Revision domains	layout
Options index	None

Public SDK signature

() => void

widget.resizewrite · write

Re-measures the mount and resizes the widget's chart surfaces to fit it.

Contract	Value
Controller	widget
Target scopes	widget
Family	terminalLayout
Implementation	sdk
Permission label	host.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	layout
Options index	None

Public SDK signature

() => void

widget.restoreMaximizedChartwrite · write

Restore a maximized multi-chart workspace. Throws in single-chart mode.

Contract	Value
Controller	widget
Target scopes	widget
Family	terminalLayout
Implementation	sdk
Permission label	host.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · widget.restoreMaximizedChart.resourceIds authority extractor · required when constrained resourceKinds · string · widget.restoreMaximizedChart.resourceKinds authority extractor · required when constrained
Revision domains	layout
Options index	None

Public SDK signature

() => void

widget.setDebugModewrite · write

Applies to every chart unless chartId scopes it.

Contract	Value
Controller	widget
Target scopes	widget
Family	chartSettings
Implementation	sdk
Permission label	host.control
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	settings
Options index	None

Public SDK signature

(enabled: boolean, chartId?: ChartId) => void

widget.setLayoutSizeswrite · write

Set relative pane weights for a split node in the multi-chart grid. Throws in single-chart mode and for unknown split ids.

Contract	Value
Controller	widget
Target scopes	widget
Family	terminalLayout
Implementation	sdk
Permission label	host.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · widget.setLayoutSizes.resourceIds authority extractor · required when constrained resourceKinds · string · widget.setLayoutSizes.resourceKinds authority extractor · required when constrained
Revision domains	layout
Options index	None

Public SDK signature

(splitId: string, sizes: number[]) => void

widget.snapshotread · read

Capture one widget through the registered bounded snapshot authority.

Contract	Value
Controller	widget
Target scopes	widget
Family	terminal
Implementation	projection
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · widget.snapshot.customizationPaths authority extractor · required when constrained drawingKinds · string · widget.snapshot.drawingKinds authority extractor · required when constrained resourceIds · string · widget.snapshot.resourceConstraintUnavailable authority extractor · required when constrained resourceKinds · string · widget.snapshot.resourceConstraintUnavailable authority extractor · required when constrained widget.snapshot.allowedSymbolsAccounts result filter · symbols, accounts
Revision domains	None
Options index	None

Public SDK signature

(options?: WidgetImageExportOptions) => Promise<AgenticSnapshotResult>

widget.toggleMaximizedChartwrite · write

Toggle one chart between maximized and normal multi-chart layout. Throws in single-chart mode.

Contract	Value
Controller	widget
Target scopes	widget
Family	terminalLayout
Implementation	sdk
Permission label	host.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · widget.toggleMaximizedChart.resourceIds authority extractor · required when constrained resourceKinds · string · widget.toggleMaximizedChart.resourceKinds authority extractor · required when constrained
Revision domains	layout
Options index	None

Public SDK signature

(chartId?: ChartId) => void

widgetBar.getStateread · read

Returns a snapshot of the current rail state: visibility, active page id, and the ordered
registered pages.

Contract	Value
Controller	widgetBar
Target scopes	widget
Family	terminalLayout
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	widgetBar.getState.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

() => WidgetBarState

widgetBar.hidePagewrite · write

Hide a page; if it was active, selection moves to the next visible page.

Contract	Value
Controller	widgetBar
Target scopes	widget
Family	terminalLayout
Implementation	sdk
Permission label	host.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · widgetBar.hidePage.resourceIds authority extractor · required when constrained resourceKinds · string · widgetBar.hidePage.resourceKinds authority extractor · required when constrained
Revision domains	ui
Options index	None

Public SDK signature

(pageId: string) => void

widgetBar.setPageswrite · write

Replace the registered pages. Active selection is preserved when still present.

Contract	Value
Controller	widgetBar
Target scopes	widget
Family	terminalLayout
Implementation	sdk
Permission label	host.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · widgetBar.setPages.resourceIds authority extractor · required when constrained resourceKinds · string · widgetBar.setPages.resourceKinds authority extractor · required when constrained
Revision domains	ui
Options index	None

Public SDK signature

(pages: WidgetBarPage[]) => void

widgetBar.setVisiblewrite · write

Show or hide the whole rail.

Contract	Value
Controller	widgetBar
Target scopes	widget
Family	terminalLayout
Implementation	sdk
Permission label	host.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · widgetBar.setVisible.resourceIds authority extractor · required when constrained resourceKinds · string · widgetBar.setVisible.resourceKinds authority extractor · required when constrained
Revision domains	ui
Options index	None

Public SDK signature

(visible: boolean) => void

widgetBar.showPagewrite · write

Open a page (makes it visible and shows the rail).

Contract	Value
Controller	widgetBar
Target scopes	widget
Family	terminalLayout
Implementation	sdk
Permission label	host.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · widgetBar.showPage.resourceIds authority extractor · required when constrained resourceKinds · string · widgetBar.showPage.resourceKinds authority extractor · required when constrained
Revision domains	ui
Options index	None

Public SDK signature

(pageId: string) => void

workspace.applyLayoutwrite · write

Applies a ChartLayout to the workspace; startDrawingSubscriptions controls whether
drawing-provider subscriptions start after the apply.

Contract	Value
Controller	workspace
Target scopes	widget
Family	chartLayouts
Implementation	sdk
Permission label	workspace.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · workspace.applyLayout.customizationPaths authority extractor · required when constrained drawingKinds · string · workspace.applyLayout.drawingKinds authority extractor · optional when constrained symbols · string · workspace.applyLayout.symbols authority extractor · required when constrained resourceIds · string · workspace.applyLayout.resourceIds authority extractor · required when constrained resourceKinds · string · workspace.applyLayout.resourceKinds authority extractor · required when constrained
Revision domains	data, viewport, content, layout, settings, replay, ui
Options index	None

Public SDK signature

(layout: ChartLayout, options?: { startDrawingSubscriptions?: boolean }) => Promise<void>

workspace.getActiveChartIdread · read

Returns the id of the currently active chart.

Contract	Value
Controller	workspace
Target scopes	widget
Family	workspace
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	workspace.getActiveChartId.allowedSymbols result filter · symbols workspace.getActiveChartId.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

() => ChartId

workspace.getLayoutread · read

Serializes the current workspace as a ChartLayout, optionally under a specific chart-layout
id and optionally embedding per-chart drawings.

Contract	Value
Controller	workspace
Target scopes	widget
Family	workspace
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · workspace.getLayout.resourceIds authority extractor · required when constrained resourceKinds · string · workspace.getLayout.resourceKinds authority extractor · required when constrained workspace.getLayout.allowedCustomizationDrawing result filter · customizationPaths, drawingKinds workspace.getLayout.allowedSymbols result filter · symbols workspace.getLayout.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

(layoutId?: ChartLayoutId, options?: { includeDrawings?: boolean }) => ChartLayout

workspace.getMaximizedChartIdread · read

Returns the id of the maximized chart, or undefined when no chart is maximized.

Contract	Value
Controller	workspace
Target scopes	widget
Family	workspace
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	workspace.getMaximizedChartId.allowedSymbols result filter · symbols workspace.getMaximizedChartId.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

() => ChartId | undefined

workspace.getMultiChartStateread · read

Returns the multi-chart grid state (split tree, selected leaf, visible and maximized chart ids),
or undefined when none exists.

Contract	Value
Controller	workspace
Target scopes	widget
Family	workspace
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	workspace.getMultiChartState.allowedSymbols result filter · symbols workspace.getMultiChartState.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

() => MultiChartWorkspaceState | undefined

workspace.getStateread · read

Returns the full workspace state: the serialized chart layout plus any multi-chart grid state.

Contract	Value
Controller	workspace
Target scopes	widget
Family	workspace
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	workspace.getState.allowedCustomizationDrawing result filter · customizationPaths, drawingKinds workspace.getState.allowedSymbols result filter · symbols workspace.getState.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

() => ChartWorkspaceState

workspace.getSyncSettingsread · read

Returns the current multi-chart sync settings.

Contract	Value
Controller	workspace
Target scopes	widget
Family	workspace
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	None
Revision domains	None
Options index	None

Public SDK signature

() => MultiChartSyncSettings

workspace.isChartMaximizedread · read

Returns whether the given chart is maximized; defaults to the active chart when no id is passed.

Contract	Value
Controller	workspace
Target scopes	widget
Family	workspace
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · workspace.isChartMaximized.resourceIds authority extractor · required when constrained resourceKinds · string · workspace.isChartMaximized.resourceKinds authority extractor · required when constrained workspace.isChartMaximized.allowedSymbols result filter · symbols
Revision domains	None
Options index	None

Public SDK signature

(chartId?: ChartId) => boolean

workspace.loadLayoutwrite · write

Loads a saved chart layout by id from the storage adapter and applies it; resolves with the
chart layout, or null when storage has no chart layout for the id.

Contract	Value
Controller	workspace
Target scopes	widget
Family	chartLayouts
Implementation	sdk
Permission label	workspace.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · workspace.loadLayout.customizationPaths authority extractor · required when constrained drawingKinds · string · workspace.loadLayout.drawingKinds authority extractor · required when constrained resourceIds · string · workspace.loadLayout.resourceConstraintUnavailable authority extractor · required when constrained resourceKinds · string · workspace.loadLayout.resourceConstraintUnavailable authority extractor · required when constrained workspace.loadLayout.allowedCustomizationDrawing result filter · customizationPaths, drawingKinds workspace.loadLayout.allowedSymbols result filter · symbols
Revision domains	data, viewport, content, layout, settings, replay, ui
Options index	None

Public SDK signature

(layoutId: ChartLayoutId, options?: { startDrawingSubscriptions?: boolean }) => Promise<ChartLayout | null>

workspace.maximizeChartwrite · write

Maximizes the given chart (the active chart when no id is passed) to fill the workspace.

Contract	Value
Controller	workspace
Target scopes	widget
Family	chartLayouts
Implementation	sdk
Permission label	workspace.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · workspace.maximizeChart.resourceIds authority extractor · required when constrained resourceKinds · string · workspace.maximizeChart.resourceKinds authority extractor · required when constrained
Revision domains	layout
Options index	None

Public SDK signature

(chartId?: ChartId) => void

workspace.resetLayoutSizeswrite · write

Clear all persisted split weights back to equal sizing.

Contract	Value
Controller	workspace
Target scopes	widget
Family	chartLayouts
Implementation	sdk
Permission label	workspace.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · workspace.resetLayoutSizes.resourceIds authority extractor · required when constrained resourceKinds · string · workspace.resetLayoutSizes.resourceKinds authority extractor · required when constrained
Revision domains	layout
Options index	None

Public SDK signature

() => void

workspace.restoreMaximizedChartwrite · write

Restores the maximized chart back into the grid.

Contract	Value
Controller	workspace
Target scopes	widget
Family	chartLayouts
Implementation	sdk
Permission label	workspace.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · workspace.restoreMaximizedChart.resourceIds authority extractor · required when constrained resourceKinds · string · workspace.restoreMaximizedChart.resourceKinds authority extractor · required when constrained
Revision domains	layout
Options index	None

Public SDK signature

() => void

workspace.saveLayoutwrite · write

Saves the chart workspace layout through the storage adapter, with options for embedding
drawings, forcing a create or update operation, and targeting a SavedLayoutRef; resolves with
the normalized SaveLayoutResult.

Contract	Value
Controller	workspace
Target scopes	widget
Family	chartLayouts
Implementation	sdk
Permission label	workspace.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · workspace.saveLayout.customizationPaths authority extractor · optional when constrained drawingKinds · string · workspace.saveLayout.drawingKinds authority extractor · optional when constrained resourceIds · string · workspace.saveLayout.resourceIds authority extractor · required when constrained resourceKinds · string · workspace.saveLayout.resourceKinds authority extractor · required when constrained
Revision domains	layout
Options index	None

Public SDK signature

(layoutId?: ChartLayoutId, options?: {
    includeDrawings?: boolean
    operation?: SaveLayoutOperation
    ref?: SavedLayoutRef
  }) => Promise<SaveLayoutResult>

workspace.setActiveChartwrite · write

Makes the chart with the given id the active chart.

Contract	Value
Controller	workspace
Target scopes	widget
Family	chartLayouts
Implementation	sdk
Permission label	workspace.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · workspace.setActiveChart.resourceIds authority extractor · required when constrained resourceKinds · string · workspace.setActiveChart.resourceKinds authority extractor · required when constrained
Revision domains	ui
Options index	None

Public SDK signature

(id: ChartId) => void

workspace.setLayoutNamewrite · write

Rename the active chart layout without reapplying its chart state.

Contract	Value
Controller	workspace
Target scopes	widget
Family	chartLayouts
Implementation	sdk
Permission label	workspace.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · workspace.setLayoutName.resourceIds authority extractor · required when constrained resourceKinds · string · workspace.setLayoutName.resourceKinds authority extractor · required when constrained
Revision domains	layout
Options index	None

Public SDK signature

(name?: string) => void

workspace.setLayoutSizeswrite · write

Set relative pane weights for a split node in the multi-chart grid.

Contract	Value
Controller	workspace
Target scopes	widget
Family	chartLayouts
Implementation	sdk
Permission label	workspace.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · workspace.setLayoutSizes.resourceIds authority extractor · required when constrained resourceKinds · string · workspace.setLayoutSizes.resourceKinds authority extractor · required when constrained
Revision domains	layout
Options index	None

Public SDK signature

(splitId: string, sizes: number[]) => void

workspace.setMultiChartStatewrite · write

Applies a multi-chart grid state, or clears it when called with no state.

Contract	Value
Controller	workspace
Target scopes	widget
Family	chartLayouts
Implementation	sdk
Permission label	workspace.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · workspace.setMultiChartState.resourceIds authority extractor · required when constrained resourceKinds · string · workspace.setMultiChartState.resourceKinds authority extractor · required when constrained
Revision domains	layout
Options index	None

Public SDK signature

(state?: MultiChartWorkspaceState) => void

workspace.setStatewrite · write

Applies a full workspace state, restoring the chart layout and multi-chart grid; resolves when
applied.

Contract	Value
Controller	workspace
Target scopes	widget
Family	chartLayouts
Implementation	sdk
Permission label	workspace.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · workspace.setState.customizationPaths authority extractor · required when constrained drawingKinds · string · workspace.setState.drawingKinds authority extractor · optional when constrained symbols · string · workspace.setState.symbols authority extractor · required when constrained resourceIds · string · workspace.setState.resourceIds authority extractor · required when constrained resourceKinds · string · workspace.setState.resourceKinds authority extractor · required when constrained
Revision domains	data, viewport, content, layout, settings, replay, ui
Options index	None

Public SDK signature

(state: ChartWorkspaceState) => Promise<void>

workspace.setSyncSettingswrite · write

Replaces the multi-chart sync settings.

Contract	Value
Controller	workspace
Target scopes	widget
Family	chartLayouts
Implementation	sdk
Permission label	workspace.control
Financial risk classes	None
Decision receipt	None
Input constraints	drawingKinds · string · workspace.setSyncSettings.drawingKinds authority extractor · optional when constrained
Revision domains	content, layout
Options index	None

Public SDK signature

(sync: MultiChartSyncSettings) => void

workspace.toggleMaximizedChartwrite · write

Toggles maximize state for the given chart (the active chart when no id is passed).

Contract	Value
Controller	workspace
Target scopes	widget
Family	chartLayouts
Implementation	sdk
Permission label	workspace.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · workspace.toggleMaximizedChart.resourceIds authority extractor · required when constrained resourceKinds · string · workspace.toggleMaximizedChart.resourceKinds authority extractor · required when constrained
Revision domains	layout
Options index	None

Public SDK signature

(chartId?: ChartId) => void

workspaceTabs.activatewrite · write

Open a saved chart layout as a tab and apply it to the active chart workspace.

Contract	Value
Controller	workspaceTabs
Target scopes	widget
Family	chartLayouts
Implementation	sdk
Permission label	workspace.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · workspaceTabs.activate.customizationPaths authority extractor · required when constrained drawingKinds · string · workspaceTabs.activate.drawingKinds authority extractor · required when constrained resourceIds · string · workspaceTabs.activate.resourceConstraintUnavailable authority extractor · required when constrained resourceKinds · string · workspaceTabs.activate.resourceConstraintUnavailable authority extractor · required when constrained
Revision domains	data, viewport, content, layout, settings, replay, ui
Options index	None

Public SDK signature

(layoutId: ChartLayoutId) => Promise<WorkspaceTab>

workspaceTabs.closewrite · write

Close an open tab without deleting its saved chart layout. At least one tab remains open.

Contract	Value
Controller	workspaceTabs
Target scopes	widget
Family	chartLayouts
Implementation	sdk
Permission label	workspace.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · workspaceTabs.close.customizationPaths authority extractor · required when constrained drawingKinds · string · workspaceTabs.close.drawingKinds authority extractor · required when constrained resourceIds · string · workspaceTabs.close.resourceIds authority extractor · required when constrained resourceKinds · string · workspaceTabs.close.resourceKinds authority extractor · required when constrained
Revision domains	data, viewport, content, layout, settings, replay, ui
Options index	None

Public SDK signature

(layoutId?: ChartLayoutId) => Promise<void>

workspaceTabs.createwrite · write

Create a new saved chart layout and activate its tab. Multi-chart widgets start with one active chart by default.

Contract	Value
Controller	workspaceTabs
Target scopes	widget
Family	chartLayouts
Implementation	sdk
Permission label	workspace.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · workspaceTabs.create.customizationPaths authority extractor · required when constrained drawingKinds · string · workspaceTabs.create.drawingKinds authority extractor · required when constrained resourceIds · string · workspaceTabs.create.resourceIds authority extractor · required when constrained resourceKinds · string · workspaceTabs.create.resourceKinds authority extractor · required when constrained
Revision domains	data, viewport, content, layout, settings, replay, ui
Options index	None

Public SDK signature

(options?: WorkspaceTabCreateOptions) => Promise<WorkspaceTab>

workspaceTabs.deletewrite · write

Delete the saved chart layout and close its tab.

Contract	Value
Controller	workspaceTabs
Target scopes	widget
Family	chartLayouts
Implementation	sdk
Permission label	workspace.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · workspaceTabs.delete.customizationPaths authority extractor · required when constrained drawingKinds · string · workspaceTabs.delete.drawingKinds authority extractor · required when constrained resourceIds · string · workspaceTabs.delete.resourceIds authority extractor · required when constrained resourceKinds · string · workspaceTabs.delete.resourceKinds authority extractor · required when constrained
Revision domains	data, viewport, content, layout, settings, replay, ui
Options index	None

Public SDK signature

(layoutId: ChartLayoutId) => Promise<void>

workspaceTabs.duplicatewrite · write

Clone an existing tab's saved chart layout as a new active chart layout.

Contract	Value
Controller	workspaceTabs
Target scopes	widget
Family	chartLayouts
Implementation	sdk
Permission label	workspace.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · workspaceTabs.duplicate.customizationPaths authority extractor · required when constrained drawingKinds · string · workspaceTabs.duplicate.drawingKinds authority extractor · required when constrained resourceIds · string · workspaceTabs.duplicate.resourceConstraintUnavailable authority extractor · required when constrained resourceKinds · string · workspaceTabs.duplicate.resourceConstraintUnavailable authority extractor · required when constrained
Revision domains	data, viewport, content, layout, settings, replay, ui
Options index	None

Public SDK signature

(layoutId?: ChartLayoutId, options?: WorkspaceTabCreateOptions) => Promise<WorkspaceTab>

workspaceTabs.getActiveTabread · read

Returns the active tab, or undefined when no open tab matches the active chart-layout id.

Contract	Value
Controller	workspaceTabs
Target scopes	widget
Family	workspace
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	workspaceTabs.getActiveTab.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

() => WorkspaceTab | undefined

workspaceTabs.getActiveTabIdread · read

Returns the chart-layout id of the active tab.

Contract	Value
Controller	workspaceTabs
Target scopes	widget
Family	workspace
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	workspaceTabs.getActiveTabId.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

() => ChartLayoutId

workspaceTabs.getTabsread · read

Returns the ordered list of currently open tabs.

Contract	Value
Controller	workspaceTabs
Target scopes	widget
Family	workspace
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	workspaceTabs.getTabs.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

() => WorkspaceTab[]

workspaceTabs.listSavedLayoutsread · read

Saved chart layouts available to open without creating a duplicate tab.

Contract	Value
Controller	workspaceTabs
Target scopes	widget
Family	workspace
Implementation	sdk
Permission label	chart.read
Financial risk classes	None
Decision receipt	None
Input constraints	workspaceTabs.listSavedLayouts.allowedSymbols result filter · symbols workspaceTabs.listSavedLayouts.allowedResources result filter · resourceIds, resourceKinds
Revision domains	None
Options index	None

Public SDK signature

() => Promise<ChartLayoutSummary[]>

workspaceTabs.movewrite · write

Move an open tab to a zero-based position.

Contract	Value
Controller	workspaceTabs
Target scopes	widget
Family	chartLayouts
Implementation	sdk
Permission label	workspace.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · workspaceTabs.move.resourceIds authority extractor · required when constrained resourceKinds · string · workspaceTabs.move.resourceKinds authority extractor · required when constrained
Revision domains	layout, settings
Options index	None

Public SDK signature

(layoutId: ChartLayoutId, index: number) => Promise<void>

workspaceTabs.refreshwrite · write

Refresh the saved chart-layout inventory without changing the current chart.

Contract	Value
Controller	workspaceTabs
Target scopes	widget
Family	chartLayouts
Implementation	sdk
Permission label	workspace.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · workspaceTabs.refresh.resourceConstraintUnavailable authority extractor · required when constrained resourceKinds · string · workspaceTabs.refresh.resourceConstraintUnavailable authority extractor · required when constrained
Revision domains	layout, settings
Options index	None

Public SDK signature

() => Promise<void>

workspaceTabs.renamewrite · write

Renames the saved chart layout behind a tab and resolves with the updated tab.

Contract	Value
Controller	workspaceTabs
Target scopes	widget
Family	chartLayouts
Implementation	sdk
Permission label	workspace.control
Financial risk classes	None
Decision receipt	None
Input constraints	resourceIds · string · workspaceTabs.rename.resourceIds authority extractor · required when constrained resourceKinds · string · workspaceTabs.rename.resourceKinds authority extractor · required when constrained
Revision domains	layout, settings
Options index	None

Public SDK signature

(layoutId: ChartLayoutId, name: string) => Promise<WorkspaceTab>

workspaceTabs.savewrite · write

Persist the active chart layout immediately.

Contract	Value
Controller	workspaceTabs
Target scopes	widget
Family	chartLayouts
Implementation	sdk
Permission label	workspace.control
Financial risk classes	None
Decision receipt	None
Input constraints	customizationPaths · string · workspaceTabs.save.customizationPaths authority extractor · required when constrained drawingKinds · string · workspaceTabs.save.drawingKinds authority extractor · required when constrained resourceIds · string · workspaceTabs.save.resourceIds authority extractor · required when constrained resourceKinds · string · workspaceTabs.save.resourceKinds authority extractor · required when constrained
Revision domains	layout, settings
Options index	None

Public SDK signature

() => Promise<void>

Subscription channels

Context returns only subscriptions available for the requested target and effective read policy. Start a bounded subscription with the exact target and one or more returned channel IDs; each binding may carry its SDK-declared options and a caller-owned bindingId.

These schemas are SDK-owned protocol contracts. The SDK validates options before invoking the mounted source and validates each projected event before delivery. Custom channels publish the same fields through live context discovery.

accountActionDialog.statesubscription

Account-action request, draft, submission, and close-intent updates.

• Options: optional; (options?: {})
• Option constraints: None
• Projected event: AccountActionDialogEvent
• Controller: accountActionDialog
• Target scopes: widget
• Access: read
• Family: account

Options schema and example

{
  "schema": {
    "type": "object",
    "properties": {},
    "required": [],
    "additionalProperties": false,
    "maxProperties": 0
  },
  "example": {}
}

Projected event schema and example

{
  "schema": {
    "type": "object",
    "properties": {
      "reason": {
        "type": "string",
        "maxLength": 64
      },
      "origin": {
        "type": "string",
        "maxLength": 64
      },
      "revision": {
        "type": "number",
        "integer": true,
        "minimum": 0
      },
      "actionId": {
        "type": "string",
        "maxLength": 128
      },
      "snapshot": {
        "type": "json",
        "maxDepth": 16,
        "maxArrayItems": 10000,
        "maxObjectProperties": 256,
        "maxStringLength": 32768,
        "maxTotalNodes": 50000
      }
    },
    "required": [
      "reason",
      "origin",
      "revision",
      "snapshot"
    ],
    "additionalProperties": false,
    "maxProperties": 5
  },
  "example": {
    "reason": "current",
    "origin": "mcp",
    "revision": 1,
    "snapshot": {
      "revision": 1
    }
  }
}

accountPanel.statesubscription

Account-panel navigation, filters, visibility, focus, and export-intent updates.

• Options: optional; (options?: {})
• Option constraints: None
• Projected event: AccountPanelEvent
• Controller: accountPanel
• Target scopes: widget
• Access: read
• Family: account

Options schema and example

{
  "schema": {
    "type": "object",
    "properties": {},
    "required": [],
    "additionalProperties": false,
    "maxProperties": 0
  },
  "example": {}
}

Projected event schema and example

{
  "schema": {
    "type": "object",
    "properties": {
      "reason": {
        "type": "string",
        "maxLength": 64
      },
      "origin": {
        "type": "string",
        "maxLength": 64
      },
      "revision": {
        "type": "number",
        "integer": true,
        "minimum": 0
      },
      "actionId": {
        "type": "string",
        "maxLength": 128
      },
      "snapshot": {
        "type": "json",
        "maxDepth": 16,
        "maxArrayItems": 10000,
        "maxObjectProperties": 256,
        "maxStringLength": 32768,
        "maxTotalNodes": 50000
      }
    },
    "required": [
      "reason",
      "origin",
      "revision",
      "snapshot"
    ],
    "additionalProperties": false,
    "maxProperties": 5
  },
  "example": {
    "reason": "active-page",
    "origin": "mcp",
    "revision": 1,
    "snapshot": {
      "revision": 1
    }
  }
}

chart.eventssubscription

Chart state and interaction events.

• Options: required; (options: { eventTypes: ChartEventType[] })
• Option constraints: None
• Projected event: ChartEvent
• Controller: chart
• Target scopes: chart
• Access: read
• Family: chart

Options schema and example

{
  "schema": {
    "type": "object",
    "properties": {
      "eventTypes": {
        "type": "array",
        "items": {
          "type": "string",
          "minLength": 1,
          "maxLength": 29,
          "enum": [
            "ready",
            "symbol-change",
            "interval-change",
            "interval-favorites-change",
            "chart-type-favorites-change",
            "drawing-tool-favorites-change",
            "indicator-favorites-change",
            "chart-type-change",
            "object-change",
            "selection-change",
            "visible-range-change",
            "price-scale-change",
            "price-scale-reset",
            "price-scale-slots-change",
            "crosshair-change",
            "display-settings-change",
            "user-settings-change",
            "indicator-change",
            "comparison-change",
            "drawings-change",
            "drawing-sharing-change",
            "layout-change",
            "active-chart-change",
            "template-change",
            "undo-redo-state-change",
            "bar-update",
            "bars-loaded",
            "hover-object-change",
            "dialog-state-change",
            "properties-dialog-change",
            "layout-load-requested",
            "layout-about-to-change",
            "autosave-needed",
            "pane-drag-end",
            "chart-pointer-down",
            "chart-pointer-move",
            "chart-pointer-up",
            "chart-drag-export",
            "drawing-tool-change",
            "replay-change",
            "customization-change",
            "action-run",
            "data-error",
            "trading-intent",
            "trading-line-change",
            "price-axis-action",
            "markers-change",
            "marker-click",
            "timescale-mark-click",
            "market-events-change",
            "market-event-click",
            "market-event-provider-error",
            "market-event-catalog-change",
            "alerts-change",
            "alert-trigger",
            "alert-activate",
            "smart-drawing-state-change",
            "smart-drawing-results-change",
            "smart-drawing-error",
            "bar-click",
            "pane-drag",
            "pane-order-change",
            "pane-layout-change",
            "widget-rail-change",
            "workspace-maximize-change",
            "watchlist-change",
            "tooltip-feature-click",
            "orderflow-heatmap-change",
            "footprint-change",
            "news-refresh-requested",
            "worker-status",
            "worker-execution",
            "state-mutation"
          ]
        },
        "minItems": 1,
        "maxItems": 73
      }
    },
    "required": [
      "eventTypes"
    ],
    "additionalProperties": false,
    "maxProperties": 1
  },
  "example": {
    "eventTypes": [
      "ready"
    ]
  }
}

Projected event schema and example

{
  "schema": {
    "type": "object",
    "properties": {
      "type": {
        "type": "string",
        "minLength": 1,
        "maxLength": 29,
        "enum": [
          "ready",
          "symbol-change",
          "interval-change",
          "interval-favorites-change",
          "chart-type-favorites-change",
          "drawing-tool-favorites-change",
          "indicator-favorites-change",
          "chart-type-change",
          "object-change",
          "selection-change",
          "visible-range-change",
          "price-scale-change",
          "price-scale-reset",
          "price-scale-slots-change",
          "crosshair-change",
          "display-settings-change",
          "user-settings-change",
          "indicator-change",
          "comparison-change",
          "drawings-change",
          "drawing-sharing-change",
          "layout-change",
          "active-chart-change",
          "template-change",
          "undo-redo-state-change",
          "bar-update",
          "bars-loaded",
          "hover-object-change",
          "dialog-state-change",
          "properties-dialog-change",
          "layout-load-requested",
          "layout-about-to-change",
          "autosave-needed",
          "pane-drag-end",
          "chart-pointer-down",
          "chart-pointer-move",
          "chart-pointer-up",
          "chart-drag-export",
          "drawing-tool-change",
          "replay-change",
          "customization-change",
          "action-run",
          "data-error",
          "trading-intent",
          "trading-line-change",
          "price-axis-action",
          "markers-change",
          "marker-click",
          "timescale-mark-click",
          "market-events-change",
          "market-event-click",
          "market-event-provider-error",
          "market-event-catalog-change",
          "alerts-change",
          "alert-trigger",
          "alert-activate",
          "smart-drawing-state-change",
          "smart-drawing-results-change",
          "smart-drawing-error",
          "bar-click",
          "pane-drag",
          "pane-order-change",
          "pane-layout-change",
          "widget-rail-change",
          "workspace-maximize-change",
          "watchlist-change",
          "tooltip-feature-click",
          "orderflow-heatmap-change",
          "footprint-change",
          "news-refresh-requested",
          "worker-status",
          "worker-execution",
          "state-mutation"
        ]
      },
      "payload": {
        "type": "json",
        "maxDepth": 16,
        "maxArrayItems": 10000,
        "maxObjectProperties": 256,
        "maxStringLength": 32768,
        "maxTotalNodes": 50000
      }
    },
    "required": [
      "type",
      "payload"
    ],
    "additionalProperties": false,
    "maxProperties": 2
  },
  "example": {
    "type": "ready",
    "payload": {}
  }
}

customization.statesubscription

Customization state updates.

• Options: optional; (options?: {})
• Option constraints: None
• Projected event: CustomizationEvent
• Controller: customization
• Target scopes: chart
• Access: read
• Family: customization

Options schema and example

{
  "schema": {
    "type": "object",
    "properties": {},
    "required": [],
    "additionalProperties": false,
    "maxProperties": 0
  },
  "example": {}
}

Projected event schema and example

{
  "schema": {
    "type": "object",
    "properties": {
      "type": {
        "type": "string",
        "maxLength": 64
      },
      "state": {
        "type": "json",
        "maxDepth": 16,
        "maxArrayItems": 10000,
        "maxObjectProperties": 256,
        "maxStringLength": 32768,
        "maxTotalNodes": 50000
      },
      "actionId": {
        "type": "string",
        "maxLength": 256
      },
      "action": {
        "type": "json",
        "maxDepth": 16,
        "maxArrayItems": 10000,
        "maxObjectProperties": 256,
        "maxStringLength": 32768,
        "maxTotalNodes": 50000
      }
    },
    "required": [
      "type",
      "state"
    ],
    "additionalProperties": false,
    "maxProperties": 4
  },
  "example": {
    "type": "state",
    "state": {}
  }
}

data.barssubscription

Real-time OHLCV bar updates.

• Options: required; (options: Omit<RealTimeBarSubscription, 'id' \| 'onResetCacheNeeded'>)
• Option constraints: dataDomains · string · bars catalog literal · required when constrained; symbols · string · args[0].symbol symbol policy identity · required when constrained
• Projected event: Bar
• Controller: data
• Target scopes: session, chart
• Access: read
• Family: marketData

Options schema and example

{
  "schema": {
    "type": "object",
    "properties": {
      "symbol": {
        "type": "object",
        "properties": {
          "ticker": {
            "type": "string",
            "maxLength": 256
          }
        },
        "required": [
          "ticker"
        ],
        "additionalProperties": {
          "type": "json",
          "maxDepth": 16,
          "maxArrayItems": 10000,
          "maxObjectProperties": 256,
          "maxStringLength": 32768,
          "maxTotalNodes": 50000
        },
        "maxProperties": 64
      },
      "interval": {
        "type": "string",
        "maxLength": 32
      },
      "transport": {
        "type": "json",
        "maxDepth": 16,
        "maxArrayItems": 10000,
        "maxObjectProperties": 256,
        "maxStringLength": 32768,
        "maxTotalNodes": 50000
      },
      "metadata": {
        "type": "json",
        "maxDepth": 16,
        "maxArrayItems": 10000,
        "maxObjectProperties": 256,
        "maxStringLength": 32768,
        "maxTotalNodes": 50000
      }
    },
    "required": [
      "symbol",
      "interval"
    ],
    "additionalProperties": false,
    "maxProperties": 4
  },
  "example": {
    "symbol": {
      "ticker": "BTC-USD"
    },
    "interval": "1m"
  }
}

Projected event schema and example

{
  "schema": {
    "type": "object",
    "properties": {
      "time": {
        "type": "number"
      },
      "open": {
        "type": "number"
      },
      "high": {
        "type": "number"
      },
      "low": {
        "type": "number"
      },
      "close": {
        "type": "number"
      },
      "volume": {
        "type": "number"
      },
      "state": {
        "type": "string",
        "minLength": 1,
        "maxLength": 10,
        "enum": [
          "developing",
          "final",
          "unknown"
        ]
      },
      "isEmpty": {
        "type": "boolean"
      },
      "turnover": {
        "type": "number"
      },
      "takerBuyVolume": {
        "type": "number"
      },
      "openInterest": {
        "type": "number"
      },
      "fundingRate": {
        "type": "number"
      }
    },
    "required": [
      "time",
      "open",
      "high",
      "low",
      "close"
    ],
    "additionalProperties": false,
    "maxProperties": 12
  },
  "example": {
    "time": 0,
    "open": 1,
    "high": 1,
    "low": 1,
    "close": 1
  }
}

data.depthsubscription

Level 2 order-book updates.

• Options: required; (options: DepthRequest)
• Option constraints: dataDomains · string · l2 catalog literal · required when constrained; symbols · string · args[0].symbol symbol policy identity · required when constrained
• Projected event: MarketDepth
• Controller: data
• Target scopes: session, chart
• Access: read
• Family: marketData

Options schema and example

{
  "schema": {
    "type": "object",
    "properties": {
      "symbol": {
        "type": "object",
        "properties": {
          "ticker": {
            "type": "string",
            "maxLength": 256
          }
        },
        "required": [
          "ticker"
        ],
        "additionalProperties": {
          "type": "json",
          "maxDepth": 16,
          "maxArrayItems": 10000,
          "maxObjectProperties": 256,
          "maxStringLength": 32768,
          "maxTotalNodes": 50000
        },
        "maxProperties": 64
      },
      "levels": {
        "type": "number",
        "integer": true,
        "minimum": 1,
        "maximum": 5000
      }
    },
    "required": [
      "symbol"
    ],
    "additionalProperties": false,
    "maxProperties": 2
  },
  "example": {
    "symbol": {
      "ticker": "BTC-USD"
    },
    "levels": 20
  }
}

Projected event schema and example

{
  "schema": {
    "type": "object",
    "properties": {
      "symbol": {
        "type": "object",
        "properties": {
          "ticker": {
            "type": "string",
            "maxLength": 256
          }
        },
        "required": [
          "ticker"
        ],
        "additionalProperties": {
          "type": "json",
          "maxDepth": 16,
          "maxArrayItems": 10000,
          "maxObjectProperties": 256,
          "maxStringLength": 32768,
          "maxTotalNodes": 50000
        },
        "maxProperties": 64
      },
      "bids": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "price": {
              "type": "number"
            },
            "size": {
              "type": "number"
            },
            "exchange": {
              "type": "string",
              "maxLength": 128
            },
            "orderCount": {
              "type": "number",
              "integer": true,
              "minimum": 0
            },
            "lots": {
              "type": "number"
            },
            "tier": {
              "type": "string",
              "maxLength": 128
            },
            "metadata": {
              "type": "json",
              "maxDepth": 16,
              "maxArrayItems": 10000,
              "maxObjectProperties": 256,
              "maxStringLength": 32768,
              "maxTotalNodes": 50000
            }
          },
          "required": [
            "price",
            "size"
          ],
          "additionalProperties": false,
          "maxProperties": 7
        },
        "maxItems": 5000
      },
      "asks": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "price": {
              "type": "number"
            },
            "size": {
              "type": "number"
            },
            "exchange": {
              "type": "string",
              "maxLength": 128
            },
            "orderCount": {
              "type": "number",
              "integer": true,
              "minimum": 0
            },
            "lots": {
              "type": "number"
            },
            "tier": {
              "type": "string",
              "maxLength": 128
            },
            "metadata": {
              "type": "json",
              "maxDepth": 16,
              "maxArrayItems": 10000,
              "maxObjectProperties": 256,
              "maxStringLength": 32768,
              "maxTotalNodes": 50000
            }
          },
          "required": [
            "price",
            "size"
          ],
          "additionalProperties": false,
          "maxProperties": 7
        },
        "maxItems": 5000
      },
      "timestamp": {
        "type": "number"
      },
      "quality": {
        "type": "object",
        "properties": {
          "mode": {
            "type": "string",
            "minLength": 1,
            "maxLength": 8,
            "enum": [
              "snapshot",
              "update"
            ]
          },
          "observedAt": {
            "type": "number"
          },
          "sourceTime": {
            "type": "number"
          },
          "sequence": {
            "type": "object",
            "properties": {
              "first": {
                "type": "number",
                "integer": true,
                "minimum": 0
              },
              "last": {
                "type": "number",
                "integer": true,
                "minimum": 0
              }
            },
            "required": [
              "first",
              "last"
            ],
            "additionalProperties": false,
            "maxProperties": 2
          },
          "continuity": {
            "type": "string",
            "minLength": 1,
            "maxLength": 14,
            "enum": [
              "not-applicable",
              "unverified",
              "continuous",
              "gap-detected"
            ]
          },
          "gap": {
            "type": "object",
            "properties": {
              "expected": {
                "type": "number",
                "integer": true,
                "minimum": 0
              },
              "received": {
                "type": "number",
                "integer": true,
                "minimum": 0
              }
            },
            "required": [
              "expected",
              "received"
            ],
            "additionalProperties": false,
            "maxProperties": 2
          },
          "resync": {
            "type": "string",
            "minLength": 1,
            "maxLength": 12,
            "enum": [
              "not-required",
              "required",
              "complete"
            ]
          }
        },
        "required": [
          "mode",
          "observedAt",
          "continuity",
          "resync"
        ],
        "additionalProperties": false,
        "maxProperties": 7
      },
      "metadata": {
        "type": "json",
        "maxDepth": 16,
        "maxArrayItems": 10000,
        "maxObjectProperties": 256,
        "maxStringLength": 32768,
        "maxTotalNodes": 50000
      }
    },
    "required": [
      "symbol",
      "bids",
      "asks"
    ],
    "additionalProperties": false,
    "maxProperties": 6
  },
  "example": {
    "symbol": {
      "ticker": "BTC-USD"
    },
    "bids": [],
    "asks": [],
    "quality": {
      "mode": "snapshot",
      "observedAt": 0,
      "continuity": "not-applicable",
      "resync": "complete"
    }
  }
}

data.eventssubscription

Market-event updates.

• Options: required; (options: Omit<MarketEventSubscription, 'id'>)
• Option constraints: dataDomains · string · events catalog literal · required when constrained; symbols · string · args[0].symbol symbol policy identity · required when constrained
• Projected event: MarketEventUpdate
• Controller: data
• Target scopes: session, chart
• Access: read
• Family: marketData

Options schema and example

{
  "schema": {
    "type": "object",
    "properties": {
      "symbol": {
        "type": "object",
        "properties": {
          "ticker": {
            "type": "string",
            "maxLength": 256
          }
        },
        "required": [
          "ticker"
        ],
        "additionalProperties": {
          "type": "json",
          "maxDepth": 16,
          "maxArrayItems": 10000,
          "maxObjectProperties": 256,
          "maxStringLength": 32768,
          "maxTotalNodes": 50000
        },
        "maxProperties": 64
      },
      "interval": {
        "type": "string",
        "maxLength": 32
      },
      "startTime": {
        "type": "number"
      },
      "endTime": {
        "type": "number"
      },
      "typeIds": {
        "type": "array",
        "items": {
          "type": "string",
          "maxLength": 256
        },
        "maxItems": 1000
      },
      "providerIds": {
        "type": "array",
        "items": {
          "type": "string",
          "maxLength": 256
        },
        "maxItems": 1000
      },
      "limit": {
        "type": "number",
        "integer": true,
        "minimum": 1,
        "maximum": 5000
      },
      "metadata": {
        "type": "json",
        "maxDepth": 16,
        "maxArrayItems": 10000,
        "maxObjectProperties": 256,
        "maxStringLength": 32768,
        "maxTotalNodes": 50000
      }
    },
    "required": [
      "symbol",
      "interval",
      "startTime",
      "endTime"
    ],
    "additionalProperties": false,
    "maxProperties": 8
  },
  "example": {
    "symbol": {
      "ticker": "BTC-USD"
    },
    "interval": "1m",
    "startTime": 0,
    "endTime": 1
  }
}

Projected event schema and example

{
  "schema": {
    "type": "object",
    "properties": {
      "kind": {
        "type": "string",
        "minLength": 1,
        "maxLength": 6,
        "enum": [
          "upsert",
          "remove"
        ]
      },
      "event": {
        "type": "json",
        "maxDepth": 16,
        "maxArrayItems": 10000,
        "maxObjectProperties": 256,
        "maxStringLength": 32768,
        "maxTotalNodes": 50000
      },
      "sourceId": {
        "type": "string",
        "maxLength": 256
      },
      "eventId": {
        "type": "string",
        "maxLength": 256
      }
    },
    "required": [
      "kind"
    ],
    "additionalProperties": false,
    "maxProperties": 4
  },
  "example": {
    "kind": "remove",
    "sourceId": "feed",
    "eventId": "event-1"
  }
}

data.quotessubscription

Level 1 quote updates.

• Options: required; (options: { symbols: Array<string \| SymbolInfo>; fastSymbols?: Array<string \| SymbolInfo> })
• Option constraints: dataDomains · string · l1 catalog literal · required when constrained; symbols · string · args[0].symbols[*] symbol policy identities, args[0].fastSymbols[*] symbol policy identities · required when constrained
• Projected event: Quote[]
• Controller: data
• Target scopes: session, chart
• Access: read
• Family: marketData

Options schema and example

{
  "schema": {
    "type": "object",
    "properties": {
      "symbols": {
        "type": "array",
        "items": {
          "oneOf": [
            {
              "type": "string",
              "maxLength": 256
            },
            {
              "type": "object",
              "properties": {
                "ticker": {
                  "type": "string",
                  "maxLength": 256
                }
              },
              "required": [
                "ticker"
              ],
              "additionalProperties": {
                "type": "json",
                "maxDepth": 16,
                "maxArrayItems": 10000,
                "maxObjectProperties": 256,
                "maxStringLength": 32768,
                "maxTotalNodes": 50000
              },
              "maxProperties": 64
            }
          ]
        },
        "minItems": 1,
        "maxItems": 1000
      },
      "fastSymbols": {
        "type": "array",
        "items": {
          "oneOf": [
            {
              "type": "string",
              "maxLength": 256
            },
            {
              "type": "object",
              "properties": {
                "ticker": {
                  "type": "string",
                  "maxLength": 256
                }
              },
              "required": [
                "ticker"
              ],
              "additionalProperties": {
                "type": "json",
                "maxDepth": 16,
                "maxArrayItems": 10000,
                "maxObjectProperties": 256,
                "maxStringLength": 32768,
                "maxTotalNodes": 50000
              },
              "maxProperties": 64
            }
          ]
        },
        "minItems": 1,
        "maxItems": 1000
      }
    },
    "required": [
      "symbols"
    ],
    "additionalProperties": false,
    "maxProperties": 2
  },
  "example": {
    "symbols": [
      "BTC-USD"
    ],
    "fastSymbols": [
      "BTC-USD"
    ]
  }
}

Projected event schema and example

{
  "schema": {
    "type": "array",
    "items": {
      "type": "object",
      "properties": {
        "symbol": {
          "type": "object",
          "properties": {
            "ticker": {
              "type": "string",
              "maxLength": 256
            }
          },
          "required": [
            "ticker"
          ],
          "additionalProperties": {
            "type": "json",
            "maxDepth": 16,
            "maxArrayItems": 10000,
            "maxObjectProperties": 256,
            "maxStringLength": 32768,
            "maxTotalNodes": 50000
          },
          "maxProperties": 64
        },
        "last": {
          "type": "number"
        },
        "bid": {
          "type": "number"
        },
        "ask": {
          "type": "number"
        },
        "spread": {
          "type": "number"
        },
        "change": {
          "type": "number"
        },
        "changePercent": {
          "type": "number"
        },
        "open": {
          "type": "number"
        },
        "high": {
          "type": "number"
        },
        "low": {
          "type": "number"
        },
        "previousClose": {
          "type": "number"
        },
        "volume": {
          "type": "number"
        },
        "timestamp": {
          "type": "number"
        },
        "extendedLast": {
          "type": "number"
        },
        "extendedChange": {
          "type": "number"
        },
        "extendedChangePercent": {
          "type": "number"
        },
        "extendedTime": {
          "type": "number"
        },
        "status": {
          "type": "string",
          "minLength": 1,
          "maxLength": 11,
          "enum": [
            "ok",
            "delayed",
            "closed",
            "unavailable"
          ]
        },
        "metadata": {
          "type": "json",
          "maxDepth": 16,
          "maxArrayItems": 10000,
          "maxObjectProperties": 256,
          "maxStringLength": 32768,
          "maxTotalNodes": 50000
        }
      },
      "required": [
        "symbol"
      ],
      "additionalProperties": false,
      "maxProperties": 19
    },
    "maxItems": 2000
  },
  "example": [
    {
      "symbol": {
        "ticker": "BTC-USD"
      },
      "bid": 50000,
      "ask": 50001
    }
  ]
}

data.sessionInfosubscription

Session-state updates.

• Options: required; (options: SessionInfoRequest)
• Option constraints: dataDomains · string · sessions catalog literal · required when constrained; symbols · string · args[0].symbol symbol policy identity · required when constrained
• Projected event: SessionInfo
• Controller: data
• Target scopes: session, chart
• Access: read
• Family: marketData

Options schema and example

{
  "schema": {
    "type": "object",
    "properties": {
      "symbol": {
        "type": "object",
        "properties": {
          "ticker": {
            "type": "string",
            "maxLength": 256
          }
        },
        "required": [
          "ticker"
        ],
        "additionalProperties": {
          "type": "json",
          "maxDepth": 16,
          "maxArrayItems": 10000,
          "maxObjectProperties": 256,
          "maxStringLength": 32768,
          "maxTotalNodes": 50000
        },
        "maxProperties": 64
      }
    },
    "required": [
      "symbol"
    ],
    "additionalProperties": false,
    "maxProperties": 1
  },
  "example": {
    "symbol": {
      "ticker": "BTC-USD"
    }
  }
}

Projected event schema and example

{
  "schema": {
    "type": "object",
    "properties": {
      "symbol": {
        "type": "object",
        "properties": {
          "ticker": {
            "type": "string",
            "maxLength": 256
          }
        },
        "required": [
          "ticker"
        ],
        "additionalProperties": {
          "type": "json",
          "maxDepth": 16,
          "maxArrayItems": 10000,
          "maxObjectProperties": 256,
          "maxStringLength": 32768,
          "maxTotalNodes": 50000
        },
        "maxProperties": 64
      },
      "timezone": {
        "type": "string",
        "maxLength": 128
      },
      "currentState": {
        "type": "string",
        "maxLength": 64
      },
      "asOf": {
        "type": "number"
      },
      "upcoming": {
        "type": "array",
        "items": {
          "type": "json",
          "maxDepth": 16,
          "maxArrayItems": 10000,
          "maxObjectProperties": 256,
          "maxStringLength": 32768,
          "maxTotalNodes": 50000
        },
        "maxItems": 1024
      },
      "note": {
        "type": "string",
        "maxLength": 1024
      },
      "metadata": {
        "type": "json",
        "maxDepth": 16,
        "maxArrayItems": 10000,
        "maxObjectProperties": 256,
        "maxStringLength": 32768,
        "maxTotalNodes": 50000
      }
    },
    "required": [
      "symbol",
      "timezone",
      "currentState",
      "asOf",
      "upcoming"
    ],
    "additionalProperties": false,
    "maxProperties": 7
  },
  "example": {
    "symbol": {
      "ticker": "BTC-USD"
    },
    "timezone": "UTC",
    "currentState": "regular",
    "asOf": 0,
    "upcoming": []
  }
}

data.timeAndSalessubscription

Tick-level trade prints.

• Options: required; (options: TimeAndSalesRequest)
• Option constraints: dataDomains · string · tape catalog literal · required when constrained; symbols · string · args[0].symbol symbol policy identity · required when constrained
• Projected event: TimeAndSalesUpdate
• Controller: data
• Target scopes: session, chart
• Access: read
• Family: orderFlow

Options schema and example

{
  "schema": {
    "type": "object",
    "properties": {
      "symbol": {
        "type": "object",
        "properties": {
          "ticker": {
            "type": "string",
            "maxLength": 256
          }
        },
        "required": [
          "ticker"
        ],
        "additionalProperties": {
          "type": "json",
          "maxDepth": 16,
          "maxArrayItems": 10000,
          "maxObjectProperties": 256,
          "maxStringLength": 32768,
          "maxTotalNodes": 50000
        },
        "maxProperties": 64
      },
      "limit": {
        "type": "number",
        "integer": true,
        "minimum": 1,
        "maximum": 20000
      },
      "startTime": {
        "type": "number"
      },
      "endTime": {
        "type": "number"
      },
      "includeOffExchange": {
        "type": "boolean"
      },
      "metadata": {
        "type": "json",
        "maxDepth": 16,
        "maxArrayItems": 10000,
        "maxObjectProperties": 256,
        "maxStringLength": 32768,
        "maxTotalNodes": 50000
      }
    },
    "required": [
      "symbol"
    ],
    "additionalProperties": false,
    "maxProperties": 6
  },
  "example": {
    "symbol": {
      "ticker": "BTC-USD"
    },
    "limit": 200
  }
}

Projected event schema and example

{
  "schema": {
    "type": "object",
    "properties": {
      "symbol": {
        "type": "object",
        "properties": {
          "ticker": {
            "type": "string",
            "maxLength": 256
          }
        },
        "required": [
          "ticker"
        ],
        "additionalProperties": {
          "type": "json",
          "maxDepth": 16,
          "maxArrayItems": 10000,
          "maxObjectProperties": 256,
          "maxStringLength": 32768,
          "maxTotalNodes": 50000
        },
        "maxProperties": 64
      },
      "prints": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "time": {
              "type": "number"
            },
            "price": {
              "type": "number"
            },
            "size": {
              "type": "number"
            },
            "aggressor": {
              "type": "string",
              "minLength": 1,
              "maxLength": 7,
              "enum": [
                "buy",
                "sell",
                "between"
              ]
            },
            "venue": {
              "type": "string",
              "maxLength": 128
            },
            "conditions": {
              "type": "array",
              "items": {
                "type": "string",
                "maxLength": 128
              },
              "maxItems": 64
            },
            "sequence": {
              "type": "number",
              "integer": true,
              "minimum": 0
            },
            "offExchange": {
              "type": "boolean"
            },
            "metadata": {
              "type": "json",
              "maxDepth": 16,
              "maxArrayItems": 10000,
              "maxObjectProperties": 256,
              "maxStringLength": 32768,
              "maxTotalNodes": 50000
            }
          },
          "required": [
            "time",
            "price",
            "size"
          ],
          "additionalProperties": false,
          "maxProperties": 9
        },
        "maxItems": 20000
      },
      "snapshot": {
        "type": "boolean"
      },
      "quality": {
        "type": "object",
        "properties": {
          "mode": {
            "type": "string",
            "minLength": 1,
            "maxLength": 8,
            "enum": [
              "snapshot",
              "update"
            ]
          },
          "observedAt": {
            "type": "number"
          },
          "sourceTime": {
            "type": "number"
          },
          "sequence": {
            "type": "object",
            "properties": {
              "first": {
                "type": "number",
                "integer": true,
                "minimum": 0
              },
              "last": {
                "type": "number",
                "integer": true,
                "minimum": 0
              }
            },
            "required": [
              "first",
              "last"
            ],
            "additionalProperties": false,
            "maxProperties": 2
          },
          "continuity": {
            "type": "string",
            "minLength": 1,
            "maxLength": 14,
            "enum": [
              "not-applicable",
              "unverified",
              "continuous",
              "gap-detected"
            ]
          },
          "gap": {
            "type": "object",
            "properties": {
              "expected": {
                "type": "number",
                "integer": true,
                "minimum": 0
              },
              "received": {
                "type": "number",
                "integer": true,
                "minimum": 0
              }
            },
            "required": [
              "expected",
              "received"
            ],
            "additionalProperties": false,
            "maxProperties": 2
          },
          "resync": {
            "type": "string",
            "minLength": 1,
            "maxLength": 12,
            "enum": [
              "not-required",
              "required",
              "complete"
            ]
          }
        },
        "required": [
          "mode",
          "observedAt",
          "continuity",
          "resync"
        ],
        "additionalProperties": false,
        "maxProperties": 7
      }
    },
    "required": [
      "symbol",
      "prints",
      "snapshot"
    ],
    "additionalProperties": false,
    "maxProperties": 4
  },
  "example": {
    "symbol": {
      "ticker": "BTC-USD"
    },
    "prints": [],
    "snapshot": true,
    "quality": {
      "mode": "snapshot",
      "observedAt": 0,
      "continuity": "unverified",
      "resync": "required"
    }
  }
}

data.watchlistsubscription

Watchlist snapshot updates.

• Options: optional; (options?: { watchlistId?: string })
• Option constraints: dataDomains · string · watchlists catalog literal · required when constrained; resourceIds · string · args[0].watchlistId · required when constrained
• Projected event: Watchlist
• Controller: data
• Target scopes: session, chart
• Access: read
• Family: watchlist

Options schema and example

{
  "schema": {
    "type": "object",
    "properties": {
      "watchlistId": {
        "type": "string",
        "maxLength": 256
      }
    },
    "required": [],
    "additionalProperties": false,
    "maxProperties": 1
  },
  "example": {}
}

Projected event schema and example

{
  "schema": {
    "type": "object",
    "properties": {
      "id": {
        "type": "string",
        "maxLength": 256
      },
      "name": {
        "type": "string",
        "maxLength": 256
      },
      "symbols": {
        "type": "array",
        "items": {
          "type": "json",
          "maxDepth": 16,
          "maxArrayItems": 10000,
          "maxObjectProperties": 256,
          "maxStringLength": 32768,
          "maxTotalNodes": 50000
        },
        "maxItems": 5000
      },
      "activeSymbol": {
        "type": "object",
        "properties": {
          "ticker": {
            "type": "string",
            "maxLength": 256
          }
        },
        "required": [
          "ticker"
        ],
        "additionalProperties": {
          "type": "json",
          "maxDepth": 16,
          "maxArrayItems": 10000,
          "maxObjectProperties": 256,
          "maxStringLength": 32768,
          "maxTotalNodes": 50000
        },
        "maxProperties": 64
      },
      "metadata": {
        "type": "json",
        "maxDepth": 16,
        "maxArrayItems": 10000,
        "maxObjectProperties": 256,
        "maxStringLength": 32768,
        "maxTotalNodes": 50000
      }
    },
    "required": [
      "id",
      "symbols"
    ],
    "additionalProperties": false,
    "maxProperties": 5
  },
  "example": {
    "id": "default",
    "symbols": []
  }
}

data.watchlistChangessubscription

Watchlist mutation facts.

• Options: optional; (options?: {})
• Option constraints: dataDomains · string · watchlists catalog literal · required when constrained
• Projected event: MarketDataWatchlistChange
• Controller: data
• Target scopes: session, chart
• Access: read
• Family: watchlist

Options schema and example

{
  "schema": {
    "type": "object",
    "properties": {},
    "required": [],
    "additionalProperties": false,
    "maxProperties": 0
  },
  "example": {}
}

Projected event schema and example

{
  "schema": {
    "type": "object",
    "properties": {
      "source": {
        "type": "string",
        "minLength": 1,
        "maxLength": 12,
        "enum": [
          "mutation",
          "subscription"
        ]
      },
      "type": {
        "type": "string",
        "minLength": 1,
        "maxLength": 10,
        "enum": [
          "create",
          "rename",
          "update",
          "set-active",
          "delete",
          "snapshot"
        ]
      },
      "watchlistId": {
        "type": "string",
        "maxLength": 256
      },
      "watchlist": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "maxLength": 256
          },
          "name": {
            "type": "string",
            "maxLength": 256
          },
          "symbols": {
            "type": "array",
            "items": {
              "type": "json",
              "maxDepth": 16,
              "maxArrayItems": 10000,
              "maxObjectProperties": 256,
              "maxStringLength": 32768,
              "maxTotalNodes": 50000
            },
            "maxItems": 5000
          },
          "activeSymbol": {
            "type": "object",
            "properties": {
              "ticker": {
                "type": "string",
                "maxLength": 256
              }
            },
            "required": [
              "ticker"
            ],
            "additionalProperties": {
              "type": "json",
              "maxDepth": 16,
              "maxArrayItems": 10000,
              "maxObjectProperties": 256,
              "maxStringLength": 32768,
              "maxTotalNodes": 50000
            },
            "maxProperties": 64
          },
          "metadata": {
            "type": "json",
            "maxDepth": 16,
            "maxArrayItems": 10000,
            "maxObjectProperties": 256,
            "maxStringLength": 32768,
            "maxTotalNodes": 50000
          }
        },
        "required": [
          "id",
          "symbols"
        ],
        "additionalProperties": false,
        "maxProperties": 5
      }
    },
    "required": [
      "source",
      "type",
      "watchlistId"
    ],
    "additionalProperties": false,
    "maxProperties": 4
  },
  "example": {
    "source": "mutation",
    "type": "delete",
    "watchlistId": "default"
  }
}

depthLadder.statesubscription

Depth-ladder draft, window, and action updates.

• Options: optional; (options?: {})
• Option constraints: None
• Projected event: DepthLadderEvent
• Controller: depthLadder
• Target scopes: widget
• Access: read
• Family: orderFlow

Options schema and example

{
  "schema": {
    "type": "object",
    "properties": {},
    "required": [],
    "additionalProperties": false,
    "maxProperties": 0
  },
  "example": {}
}

Projected event schema and example

{
  "schema": {
    "type": "object",
    "properties": {
      "reason": {
        "type": "string",
        "maxLength": 64
      },
      "origin": {
        "type": "string",
        "maxLength": 64
      },
      "revision": {
        "type": "number",
        "integer": true,
        "minimum": 0
      },
      "actionId": {
        "type": "string",
        "maxLength": 128
      },
      "snapshot": {
        "type": "json",
        "maxDepth": 16,
        "maxArrayItems": 10000,
        "maxObjectProperties": 256,
        "maxStringLength": 32768,
        "maxTotalNodes": 50000
      }
    },
    "required": [
      "reason",
      "origin",
      "revision",
      "snapshot"
    ],
    "additionalProperties": false,
    "maxProperties": 5
  },
  "example": {
    "reason": "ready",
    "origin": "api",
    "revision": 1,
    "snapshot": {
      "revision": 1
    }
  }
}

marketDepth.statesubscription

Bounded Level 2 market-depth state updates.

• Options: optional; (options?: { emitCurrent?: boolean })
• Option constraints: dataDomains · string · l2 catalog literal · required when constrained
• Projected event: MarketDepthControllerEvent
• Controller: marketDepth
• Target scopes: widget
• Access: read
• Family: orderFlow

Options schema and example

{
  "schema": {
    "type": "object",
    "properties": {
      "emitCurrent": {
        "type": "boolean"
      }
    },
    "required": [],
    "additionalProperties": false,
    "maxProperties": 1
  },
  "example": {
    "emitCurrent": true
  }
}

Projected event schema and example

{
  "schema": {
    "type": "object",
    "properties": {
      "reason": {
        "type": "string",
        "maxLength": 64
      },
      "origin": {
        "type": "string",
        "maxLength": 64
      },
      "revision": {
        "type": "number",
        "integer": true,
        "minimum": 0
      },
      "actionId": {
        "type": "string",
        "maxLength": 128
      },
      "snapshot": {
        "type": "json",
        "maxDepth": 16,
        "maxArrayItems": 10000,
        "maxObjectProperties": 256,
        "maxStringLength": 32768,
        "maxTotalNodes": 50000
      }
    },
    "required": [
      "reason",
      "revision",
      "snapshot"
    ],
    "additionalProperties": false,
    "maxProperties": 5
  },
  "example": {
    "reason": "data",
    "revision": 1,
    "snapshot": {
      "revision": 1
    }
  }
}

optionChain.statesubscription

Option-chain expiration, strike window, and contract-selection updates.

• Options: optional; (options?: { emitCurrent?: boolean })
• Option constraints: dataDomains · string · options catalog literal · required when constrained
• Projected event: OptionChainControllerEvent
• Controller: optionChain
• Target scopes: widget
• Access: read
• Family: options

Options schema and example

{
  "schema": {
    "type": "object",
    "properties": {
      "emitCurrent": {
        "type": "boolean"
      }
    },
    "required": [],
    "additionalProperties": false,
    "maxProperties": 1
  },
  "example": {
    "emitCurrent": true
  }
}

Projected event schema and example

{
  "schema": {
    "type": "object",
    "properties": {
      "reason": {
        "type": "string",
        "maxLength": 64
      },
      "origin": {
        "type": "string",
        "maxLength": 64
      },
      "revision": {
        "type": "number",
        "integer": true,
        "minimum": 0
      },
      "actionId": {
        "type": "string",
        "maxLength": 128
      },
      "snapshot": {
        "type": "json",
        "maxDepth": 16,
        "maxArrayItems": 10000,
        "maxObjectProperties": 256,
        "maxStringLength": 32768,
        "maxTotalNodes": 50000
      }
    },
    "required": [
      "reason",
      "origin",
      "revision",
      "snapshot"
    ],
    "additionalProperties": false,
    "maxProperties": 5
  },
  "example": {
    "reason": "expiration",
    "origin": "mcp",
    "revision": 1,
    "snapshot": {
      "revision": 1
    }
  }
}

optionTicket.statesubscription

Option-ticket legs, strategy, risk, draft, and submission updates.

• Options: optional; (options?: { emitCurrent?: boolean })
• Option constraints: dataDomains · string · options catalog literal · required when constrained
• Projected event: OptionTicketControllerEvent
• Controller: optionTicket
• Target scopes: widget
• Access: read
• Family: options

Options schema and example

{
  "schema": {
    "type": "object",
    "properties": {
      "emitCurrent": {
        "type": "boolean"
      }
    },
    "required": [],
    "additionalProperties": false,
    "maxProperties": 1
  },
  "example": {
    "emitCurrent": true
  }
}

Projected event schema and example

{
  "schema": {
    "type": "object",
    "properties": {
      "reason": {
        "type": "string",
        "maxLength": 64
      },
      "origin": {
        "type": "string",
        "maxLength": 64
      },
      "revision": {
        "type": "number",
        "integer": true,
        "minimum": 0
      },
      "actionId": {
        "type": "string",
        "maxLength": 128
      },
      "snapshot": {
        "type": "json",
        "maxDepth": 16,
        "maxArrayItems": 10000,
        "maxObjectProperties": 256,
        "maxStringLength": 32768,
        "maxTotalNodes": 50000
      }
    },
    "required": [
      "reason",
      "origin",
      "revision",
      "snapshot"
    ],
    "additionalProperties": false,
    "maxProperties": 5
  },
  "example": {
    "reason": "leg-updated",
    "origin": "mcp",
    "revision": 1,
    "snapshot": {
      "revision": 1
    }
  }
}

orderFlow.statesubscription

Bounded liquidity, delta, and heatmap projection updates.

• Options: optional; (options?: { emitCurrent?: boolean })
• Option constraints: dataDomains · string · l2 catalog literal, tape catalog literal · required when constrained
• Projected event: OrderFlowContextEvent
• Controller: orderFlow
• Target scopes: widget
• Access: read
• Family: orderFlow

Options schema and example

{
  "schema": {
    "type": "object",
    "properties": {
      "emitCurrent": {
        "type": "boolean"
      }
    },
    "required": [],
    "additionalProperties": false,
    "maxProperties": 1
  },
  "example": {
    "emitCurrent": true
  }
}

Projected event schema and example

{
  "schema": {
    "type": "object",
    "properties": {
      "reason": {
        "type": "string",
        "maxLength": 64
      },
      "origin": {
        "type": "string",
        "maxLength": 64
      },
      "revision": {
        "type": "number",
        "integer": true,
        "minimum": 0
      },
      "actionId": {
        "type": "string",
        "maxLength": 128
      },
      "snapshot": {
        "type": "json",
        "maxDepth": 16,
        "maxArrayItems": 10000,
        "maxObjectProperties": 256,
        "maxStringLength": 32768,
        "maxTotalNodes": 50000
      }
    },
    "required": [
      "reason",
      "revision",
      "snapshot"
    ],
    "additionalProperties": false,
    "maxProperties": 5
  },
  "example": {
    "reason": "sample",
    "revision": 1,
    "snapshot": {
      "revision": 1
    }
  }
}

orderTicket.statesubscription

Order-ticket draft, preview, and execution updates.

• Options: optional; (options?: {})
• Option constraints: None
• Projected event: OrderTicketEvent
• Controller: orderTicket
• Target scopes: widget
• Access: read
• Family: trading

Options schema and example

{
  "schema": {
    "type": "object",
    "properties": {},
    "required": [],
    "additionalProperties": false,
    "maxProperties": 0
  },
  "example": {}
}

Projected event schema and example

{
  "schema": {
    "type": "object",
    "properties": {
      "reason": {
        "type": "string",
        "maxLength": 64
      },
      "origin": {
        "type": "string",
        "maxLength": 64
      },
      "revision": {
        "type": "number",
        "integer": true,
        "minimum": 0
      },
      "actionId": {
        "type": "string",
        "maxLength": 128
      },
      "snapshot": {
        "type": "json",
        "maxDepth": 16,
        "maxArrayItems": 10000,
        "maxObjectProperties": 256,
        "maxStringLength": 32768,
        "maxTotalNodes": 50000
      }
    },
    "required": [
      "reason",
      "origin",
      "revision",
      "snapshot"
    ],
    "additionalProperties": false,
    "maxProperties": 5
  },
  "example": {
    "reason": "quantity",
    "origin": "mcp",
    "revision": 1,
    "snapshot": {
      "revision": 1
    }
  }
}

orderTicketLauncher.statesubscription

Order-ticket launcher visibility and invocation-intent updates.

• Options: optional; (options?: {})
• Option constraints: None
• Projected event: BrokerOrderTicketLauncherEvent
• Controller: orderTicketLauncher
• Target scopes: widget
• Access: read
• Family: trading

Options schema and example

{
  "schema": {
    "type": "object",
    "properties": {},
    "required": [],
    "additionalProperties": false,
    "maxProperties": 0
  },
  "example": {}
}

Projected event schema and example

{
  "schema": {
    "type": "object",
    "properties": {
      "reason": {
        "type": "string",
        "maxLength": 64
      },
      "origin": {
        "type": "string",
        "maxLength": 64
      },
      "revision": {
        "type": "number",
        "integer": true,
        "minimum": 0
      },
      "actionId": {
        "type": "string",
        "maxLength": 128
      },
      "snapshot": {
        "type": "json",
        "maxDepth": 16,
        "maxArrayItems": 10000,
        "maxObjectProperties": 256,
        "maxStringLength": 32768,
        "maxTotalNodes": 50000
      }
    },
    "required": [
      "reason",
      "origin",
      "revision",
      "snapshot"
    ],
    "additionalProperties": false,
    "maxProperties": 5
  },
  "example": {
    "reason": "open",
    "origin": "mcp",
    "revision": 1,
    "snapshot": {
      "revision": 1
    }
  }
}

panelLayout.statesubscription

Terminal panel-layout updates.

• Options: optional; (options?: {})
• Option constraints: None
• Projected event: PanelLayoutEvent
• Controller: panelLayout
• Target scopes: session, widget
• Access: read
• Family: terminalLayout

Options schema and example

{
  "schema": {
    "type": "object",
    "properties": {},
    "required": [],
    "additionalProperties": false,
    "maxProperties": 0
  },
  "example": {}
}

Projected event schema and example

{
  "schema": {
    "type": "object",
    "properties": {
      "reason": {
        "type": "string",
        "maxLength": 64
      },
      "origin": {
        "type": "string",
        "maxLength": 64
      },
      "revision": {
        "type": "number",
        "integer": true,
        "minimum": 0
      },
      "actionId": {
        "type": "string",
        "maxLength": 128
      },
      "snapshot": {
        "type": "json",
        "maxDepth": 16,
        "maxArrayItems": 10000,
        "maxObjectProperties": 256,
        "maxStringLength": 32768,
        "maxTotalNodes": 50000
      }
    },
    "required": [
      "reason",
      "origin",
      "revision",
      "snapshot"
    ],
    "additionalProperties": false,
    "maxProperties": 5
  },
  "example": {
    "reason": "ready",
    "origin": "api",
    "revision": 1,
    "snapshot": {
      "revision": 1
    }
  }
}

replay.statesubscription

Replay state updates.

• Options: optional; (options?: {})
• Option constraints: None
• Projected event: ReplayEvent
• Controller: replay
• Target scopes: chart
• Access: read
• Family: replay

Options schema and example

{
  "schema": {
    "type": "object",
    "properties": {},
    "required": [],
    "additionalProperties": false,
    "maxProperties": 0
  },
  "example": {}
}

Projected event schema and example

{
  "schema": {
    "type": "object",
    "properties": {
      "type": {
        "type": "string",
        "maxLength": 64
      },
      "state": {
        "oneOf": [
          {
            "type": "null"
          },
          {
            "type": "object",
            "properties": {
              "status": {
                "type": "string",
                "minLength": 1,
                "maxLength": 7,
                "enum": [
                  "idle",
                  "picking",
                  "paused",
                  "playing",
                  "ended"
                ]
              }
            },
            "required": [
              "status"
            ],
            "additionalProperties": {
              "type": "json",
              "maxDepth": 16,
              "maxArrayItems": 10000,
              "maxObjectProperties": 256,
              "maxStringLength": 32768,
              "maxTotalNodes": 50000
            },
            "maxProperties": 8
          }
        ]
      }
    },
    "required": [
      "type",
      "state"
    ],
    "additionalProperties": false,
    "maxProperties": 2
  },
  "example": {
    "type": "state",
    "state": {
      "status": "idle"
    }
  }
}

risk.decisionssubscription

Immutable pre-trade risk decision receipts.

• Options: optional; (options?: {})
• Option constraints: None
• Projected event: RiskDecisionReceipt
• Controller: risk
• Target scopes: session
• Access: read
• Family: risk

Options schema and example

{
  "schema": {
    "type": "object",
    "properties": {},
    "required": [],
    "additionalProperties": false,
    "maxProperties": 0
  },
  "example": {}
}

Projected event schema and example

{
  "schema": {
    "type": "object",
    "properties": {
      "decisionId": {
        "type": "string",
        "maxLength": 3079
      },
      "sequence": {
        "type": "number",
        "integer": true,
        "minimum": 0
      },
      "decidedAt": {
        "type": "number"
      },
      "status": {
        "type": "string",
        "minLength": 1,
        "maxLength": 17,
        "enum": [
          "allow",
          "reject",
          "approval-required"
        ]
      },
      "autonomyMode": {
        "type": "string",
        "minLength": 1,
        "maxLength": 18,
        "enum": [
          "observe-only",
          "propose",
          "paper-auto",
          "live-with-approval",
          "bounded-live-auto"
        ]
      },
      "policyVersion": {
        "type": "number",
        "integer": true,
        "minimum": 0
      },
      "utilizationRevision": {
        "type": "number",
        "integer": true,
        "minimum": 0
      },
      "request": {
        "type": "json",
        "maxDepth": 16,
        "maxArrayItems": 10000,
        "maxObjectProperties": 256,
        "maxStringLength": 32768,
        "maxTotalNodes": 50000
      },
      "reasons": {
        "type": "array",
        "items": {
          "type": "json",
          "maxDepth": 16,
          "maxArrayItems": 10000,
          "maxObjectProperties": 256,
          "maxStringLength": 32768,
          "maxTotalNodes": 50000
        },
        "maxItems": 128
      }
    },
    "required": [
      "decisionId",
      "sequence",
      "decidedAt",
      "status",
      "autonomyMode",
      "policyVersion",
      "utilizationRevision",
      "request",
      "reasons"
    ],
    "additionalProperties": false,
    "maxProperties": 9
  },
  "example": {
    "decisionId": "decision-1",
    "sequence": 1,
    "decidedAt": 0,
    "status": "allow",
    "autonomyMode": "paper-auto",
    "policyVersion": 1,
    "utilizationRevision": 1,
    "request": {
      "kind": "order-exposure",
      "decisionId": "decision-1",
      "requestedAt": 0,
      "executionEnvironment": "paper",
      "accountId": "paper",
      "instrumentId": "BTC-USD",
      "session": "regular",
      "side": "buy",
      "orderType": "market",
      "quantity": 0.01,
      "notional": 500,
      "projectedPositionQuantity": 0.01,
      "projectedPositionNotional": 500,
      "estimatedSlippageBps": 1,
      "marketDataAsOf": 0
    },
    "reasons": []
  }
}

risk.statesubscription

Host risk policy, utilization, emergency, and decision-state changes.

• Options: optional; (options?: RiskPolicyStateSubscriptionOptions)
• Option constraints: None
• Projected event: RiskPolicyEvent
• Controller: risk
• Target scopes: session
• Access: read
• Family: risk

Options schema and example

{
  "schema": {
    "type": "object",
    "properties": {
      "emitCurrent": {
        "type": "boolean"
      }
    },
    "required": [],
    "additionalProperties": false,
    "maxProperties": 1
  },
  "example": {
    "emitCurrent": true
  }
}

Projected event schema and example

{
  "schema": {
    "type": "object",
    "properties": {
      "type": {
        "type": "string",
        "minLength": 1,
        "maxLength": 19,
        "enum": [
          "policy-narrowed",
          "utilization-changed",
          "decision",
          "kill-switch-engaged",
          "kill-switch-cleared"
        ]
      },
      "state": {
        "type": "json",
        "maxDepth": 16,
        "maxArrayItems": 10000,
        "maxObjectProperties": 256,
        "maxStringLength": 32768,
        "maxTotalNodes": 50000
      },
      "receipt": {
        "type": "json",
        "maxDepth": 16,
        "maxArrayItems": 10000,
        "maxObjectProperties": 256,
        "maxStringLength": 32768,
        "maxTotalNodes": 50000
      }
    },
    "required": [
      "type",
      "state"
    ],
    "additionalProperties": false,
    "maxProperties": 3
  },
  "example": {
    "type": "utilization-changed",
    "state": {}
  }
}

symbolLink.statesubscription

Linked symbol and membership updates.

• Options: optional; (options?: { emitCurrent?: boolean })
• Option constraints: None
• Projected event: SymbolLinkControllerEvent
• Controller: symbolLink
• Target scopes: session, widget
• Access: read
• Family: chartNavigation

Options schema and example

{
  "schema": {
    "type": "object",
    "properties": {
      "emitCurrent": {
        "type": "boolean"
      }
    },
    "required": [],
    "additionalProperties": false,
    "maxProperties": 1
  },
  "example": {
    "emitCurrent": true
  }
}

Projected event schema and example

{
  "schema": {
    "type": "object",
    "properties": {
      "type": {
        "type": "string",
        "minLength": 1,
        "maxLength": 14,
        "enum": [
          "symbol-changed",
          "member-added",
          "member-removed"
        ]
      },
      "revision": {
        "type": "number",
        "integer": true,
        "minimum": 0
      },
      "state": {
        "type": "json",
        "maxDepth": 16,
        "maxArrayItems": 10000,
        "maxObjectProperties": 256,
        "maxStringLength": 32768,
        "maxTotalNodes": 50000
      },
      "member": {
        "type": "json",
        "maxDepth": 16,
        "maxArrayItems": 10000,
        "maxObjectProperties": 256,
        "maxStringLength": 32768,
        "maxTotalNodes": 50000
      }
    },
    "required": [
      "type",
      "revision",
      "state"
    ],
    "additionalProperties": false,
    "maxProperties": 4
  },
  "example": {
    "type": "symbol-changed",
    "revision": 1,
    "state": {
      "groupId": "default",
      "revision": 1,
      "members": []
    }
  }
}

timeAndSales.statesubscription

Filtered live tape state updates.

• Options: optional; (options?: { emitCurrent?: boolean })
• Option constraints: dataDomains · string · tape catalog literal · required when constrained
• Projected event: TimeAndSalesControllerEvent
• Controller: timeAndSales
• Target scopes: widget
• Access: read
• Family: orderFlow

Options schema and example

{
  "schema": {
    "type": "object",
    "properties": {
      "emitCurrent": {
        "type": "boolean"
      }
    },
    "required": [],
    "additionalProperties": false,
    "maxProperties": 1
  },
  "example": {
    "emitCurrent": true
  }
}

Projected event schema and example

{
  "schema": {
    "type": "object",
    "properties": {
      "reason": {
        "type": "string",
        "maxLength": 64
      },
      "origin": {
        "type": "string",
        "maxLength": 64
      },
      "revision": {
        "type": "number",
        "integer": true,
        "minimum": 0
      },
      "actionId": {
        "type": "string",
        "maxLength": 128
      },
      "snapshot": {
        "type": "json",
        "maxDepth": 16,
        "maxArrayItems": 10000,
        "maxObjectProperties": 256,
        "maxStringLength": 32768,
        "maxTotalNodes": 50000
      }
    },
    "required": [
      "reason",
      "revision",
      "snapshot"
    ],
    "additionalProperties": false,
    "maxProperties": 5
  },
  "example": {
    "reason": "data",
    "revision": 1,
    "snapshot": {
      "revision": 1
    }
  }
}

timeScale.barSpacingsubscription

Time-scale bar-spacing changes.

• Options: optional; (options?: { callWithLast?: boolean })
• Option constraints: None
• Projected event: number
• Controller: timeScale
• Target scopes: chart
• Access: read
• Family: chartNavigation

Options schema and example

{
  "schema": {
    "type": "object",
    "properties": {
      "callWithLast": {
        "type": "boolean"
      }
    },
    "required": [],
    "additionalProperties": false,
    "maxProperties": 1
  },
  "example": {
    "callWithLast": true
  }
}

Projected event schema and example

{
  "schema": {
    "type": "number"
  },
  "example": 6
}

timeScale.inactivityGapssubscription

Time-scale inactivity-gap changes.

• Options: optional; (options?: { callWithLast?: boolean })
• Option constraints: None
• Projected event: boolean
• Controller: timeScale
• Target scopes: chart
• Access: read
• Family: chartNavigation

Options schema and example

{
  "schema": {
    "type": "object",
    "properties": {
      "callWithLast": {
        "type": "boolean"
      }
    },
    "required": [],
    "additionalProperties": false,
    "maxProperties": 1
  },
  "example": {
    "callWithLast": true
  }
}

Projected event schema and example

{
  "schema": {
    "type": "boolean"
  },
  "example": false
}

timeScale.rightOffsetsubscription

Time-scale right-offset changes.

• Options: optional; (options?: { callWithLast?: boolean })
• Option constraints: None
• Projected event: number
• Controller: timeScale
• Target scopes: chart
• Access: read
• Family: chartNavigation

Options schema and example

{
  "schema": {
    "type": "object",
    "properties": {
      "callWithLast": {
        "type": "boolean"
      }
    },
    "required": [],
    "additionalProperties": false,
    "maxProperties": 1
  },
  "example": {
    "callWithLast": true
  }
}

Projected event schema and example

{
  "schema": {
    "type": "number"
  },
  "example": 0
}

trading.equitysubscription

Account equity updates.

• Options: required; (options: TradingEquityRequest)
• Option constraints: accounts · string · args[0].accountId · required when constrained
• Projected event: number \| null
• Controller: trading
• Target scopes: session, chart
• Access: read
• Family: account

Options schema and example

{
  "schema": {
    "type": "object",
    "properties": {
      "accountId": {
        "type": "string",
        "maxLength": 256
      }
    },
    "required": [],
    "additionalProperties": false,
    "maxProperties": 1
  },
  "example": {}
}

Projected event schema and example

{
  "schema": {
    "oneOf": [
      {
        "type": "null"
      },
      {
        "type": "number"
      }
    ]
  },
  "example": 25000
}

trading.eventssubscription

Orders, positions, executions, connection, and account events.

• Options: optional; (options?: {})
• Option constraints: None
• Projected event: TradingEvent
• Controller: trading
• Target scopes: session, chart
• Access: read
• Family: trading

Options schema and example

{
  "schema": {
    "type": "object",
    "properties": {},
    "required": [],
    "additionalProperties": false,
    "maxProperties": 0
  },
  "example": {}
}

Projected event schema and example

{
  "schema": {
    "type": "object",
    "properties": {
      "type": {
        "type": "string",
        "maxLength": 64
      }
    },
    "required": [
      "type"
    ],
    "additionalProperties": {
      "type": "json",
      "maxDepth": 16,
      "maxArrayItems": 10000,
      "maxObjectProperties": 256,
      "maxStringLength": 32768,
      "maxTotalNodes": 50000
    },
    "maxProperties": 16
  },
  "example": {
    "type": "orders",
    "orders": []
  }
}

trading.marginAvailablesubscription

Available margin updates.

• Options: required; (options: TradingMarginAvailableRequest)
• Option constraints: accounts · string · args[0].accountId · required when constrained; symbols · string · args[0].symbol symbol policy identity · required when constrained
• Projected event: number \| null
• Controller: trading
• Target scopes: session, chart
• Access: read
• Family: account

Options schema and example

{
  "schema": {
    "type": "object",
    "properties": {
      "accountId": {
        "type": "string",
        "maxLength": 256
      },
      "symbol": {
        "type": "object",
        "properties": {
          "ticker": {
            "type": "string",
            "maxLength": 256
          }
        },
        "required": [
          "ticker"
        ],
        "additionalProperties": {
          "type": "json",
          "maxDepth": 16,
          "maxArrayItems": 10000,
          "maxObjectProperties": 256,
          "maxStringLength": 32768,
          "maxTotalNodes": 50000
        },
        "maxProperties": 64
      }
    },
    "required": [
      "symbol"
    ],
    "additionalProperties": false,
    "maxProperties": 2
  },
  "example": {
    "symbol": {
      "ticker": "BTC-USD"
    }
  }
}

Projected event schema and example

{
  "schema": {
    "oneOf": [
      {
        "type": "null"
      },
      {
        "type": "number"
      }
    ]
  },
  "example": 20000
}

trading.pipValuesubscription

Pip-value updates.

• Options: required; (options: TradingPipValueRequest)
• Option constraints: accounts · string · args[0].accountId · required when constrained; symbols · string · args[0].symbol symbol policy identity · required when constrained
• Projected event: number \| null
• Controller: trading
• Target scopes: session, chart
• Access: read
• Family: account

Options schema and example

{
  "schema": {
    "type": "object",
    "properties": {
      "accountId": {
        "type": "string",
        "maxLength": 256
      },
      "symbol": {
        "type": "object",
        "properties": {
          "ticker": {
            "type": "string",
            "maxLength": 256
          }
        },
        "required": [
          "ticker"
        ],
        "additionalProperties": {
          "type": "json",
          "maxDepth": 16,
          "maxArrayItems": 10000,
          "maxObjectProperties": 256,
          "maxStringLength": 32768,
          "maxTotalNodes": 50000
        },
        "maxProperties": 64
      }
    },
    "required": [
      "symbol"
    ],
    "additionalProperties": false,
    "maxProperties": 2
  },
  "example": {
    "symbol": {
      "ticker": "BTC-USD"
    }
  }
}

Projected event schema and example

{
  "schema": {
    "oneOf": [
      {
        "type": "null"
      },
      {
        "type": "number"
      }
    ]
  },
  "example": 1
}

trading.suggestedQuantitysubscription

Order-ticket suggested quantity updates.

• Options: required; (options: TradingSuggestedQuantityRequest)
• Option constraints: accounts · string · args[0].accountId · required when constrained; symbols · string · args[0].symbol symbol policy identity · required when constrained
• Projected event: number \| null
• Controller: trading
• Target scopes: session, chart
• Access: read
• Family: trading

Options schema and example

{
  "schema": {
    "type": "object",
    "properties": {
      "accountId": {
        "type": "string",
        "maxLength": 256
      },
      "symbol": {
        "type": "object",
        "properties": {
          "ticker": {
            "type": "string",
            "maxLength": 256
          }
        },
        "required": [
          "ticker"
        ],
        "additionalProperties": {
          "type": "json",
          "maxDepth": 16,
          "maxArrayItems": 10000,
          "maxObjectProperties": 256,
          "maxStringLength": 32768,
          "maxTotalNodes": 50000
        },
        "maxProperties": 64
      }
    },
    "required": [],
    "additionalProperties": false,
    "maxProperties": 2
  },
  "example": {
    "symbol": {
      "ticker": "BTC-USD"
    }
  }
}

Projected event schema and example

{
  "schema": {
    "oneOf": [
      {
        "type": "null"
      },
      {
        "type": "number"
      }
    ]
  },
  "example": 0.01
}

watchlist.statesubscription

Watchlist data, selection, and durable view-state updates.

• Options: optional; (options?: {})
• Option constraints: dataDomains · string · watchlists catalog literal, l1 catalog literal · required when constrained
• Projected event: WatchlistEvent
• Controller: watchlist
• Target scopes: widget
• Access: read
• Family: watchlist

Options schema and example

{
  "schema": {
    "type": "object",
    "properties": {},
    "required": [],
    "additionalProperties": false,
    "maxProperties": 0
  },
  "example": {}
}

Projected event schema and example

{
  "schema": {
    "type": "object",
    "properties": {
      "reason": {
        "type": "string",
        "maxLength": 64
      },
      "origin": {
        "type": "string",
        "maxLength": 64
      },
      "revision": {
        "type": "number",
        "integer": true,
        "minimum": 0
      },
      "actionId": {
        "type": "string",
        "maxLength": 128
      },
      "snapshot": {
        "type": "json",
        "maxDepth": 16,
        "maxArrayItems": 10000,
        "maxObjectProperties": 256,
        "maxStringLength": 32768,
        "maxTotalNodes": 50000
      }
    },
    "required": [
      "reason",
      "origin",
      "revision",
      "snapshot"
    ],
    "additionalProperties": false,
    "maxProperties": 5
  },
  "example": {
    "reason": "refresh",
    "origin": "api",
    "revision": 1,
    "snapshot": {
      "revision": 1
    }
  }
}

widget.eventssubscription

Widget lifecycle and interaction events.

• Options: required; (options: { eventTypes: WidgetEventType[] })
• Option constraints: None
• Projected event: WidgetEvent
• Controller: widget
• Target scopes: widget
• Access: read
• Family: terminal

Options schema and example

{
  "schema": {
    "type": "object",
    "properties": {
      "eventTypes": {
        "type": "array",
        "items": {
          "type": "string",
          "minLength": 1,
          "maxLength": 29,
          "enum": [
            "ready",
            "symbol-change",
            "interval-change",
            "interval-favorites-change",
            "chart-type-favorites-change",
            "drawing-tool-favorites-change",
            "indicator-favorites-change",
            "chart-type-change",
            "object-change",
            "selection-change",
            "visible-range-change",
            "price-scale-change",
            "price-scale-reset",
            "price-scale-slots-change",
            "crosshair-change",
            "display-settings-change",
            "user-settings-change",
            "indicator-change",
            "comparison-change",
            "drawings-change",
            "drawing-sharing-change",
            "layout-change",
            "active-chart-change",
            "template-change",
            "undo-redo-state-change",
            "bar-update",
            "bars-loaded",
            "hover-object-change",
            "dialog-state-change",
            "properties-dialog-change",
            "layout-load-requested",
            "layout-about-to-change",
            "autosave-needed",
            "pane-drag-end",
            "chart-pointer-down",
            "chart-pointer-move",
            "chart-pointer-up",
            "chart-drag-export",
            "drawing-tool-change",
            "replay-change",
            "customization-change",
            "action-run",
            "data-error",
            "trading-intent",
            "trading-line-change",
            "price-axis-action",
            "markers-change",
            "marker-click",
            "timescale-mark-click",
            "market-events-change",
            "market-event-click",
            "market-event-provider-error",
            "market-event-catalog-change",
            "alerts-change",
            "alert-trigger",
            "alert-activate",
            "smart-drawing-state-change",
            "smart-drawing-results-change",
            "smart-drawing-error",
            "bar-click",
            "pane-drag",
            "pane-order-change",
            "pane-layout-change",
            "widget-rail-change",
            "workspace-maximize-change",
            "watchlist-change",
            "tooltip-feature-click",
            "orderflow-heatmap-change",
            "footprint-change",
            "news-refresh-requested",
            "worker-status",
            "worker-execution",
            "state-mutation"
          ]
        },
        "minItems": 1,
        "maxItems": 73
      }
    },
    "required": [
      "eventTypes"
    ],
    "additionalProperties": false,
    "maxProperties": 1
  },
  "example": {
    "eventTypes": [
      "ready"
    ]
  }
}

Projected event schema and example

{
  "schema": {
    "type": "object",
    "properties": {
      "type": {
        "type": "string",
        "minLength": 1,
        "maxLength": 29,
        "enum": [
          "ready",
          "symbol-change",
          "interval-change",
          "interval-favorites-change",
          "chart-type-favorites-change",
          "drawing-tool-favorites-change",
          "indicator-favorites-change",
          "chart-type-change",
          "object-change",
          "selection-change",
          "visible-range-change",
          "price-scale-change",
          "price-scale-reset",
          "price-scale-slots-change",
          "crosshair-change",
          "display-settings-change",
          "user-settings-change",
          "indicator-change",
          "comparison-change",
          "drawings-change",
          "drawing-sharing-change",
          "layout-change",
          "active-chart-change",
          "template-change",
          "undo-redo-state-change",
          "bar-update",
          "bars-loaded",
          "hover-object-change",
          "dialog-state-change",
          "properties-dialog-change",
          "layout-load-requested",
          "layout-about-to-change",
          "autosave-needed",
          "pane-drag-end",
          "chart-pointer-down",
          "chart-pointer-move",
          "chart-pointer-up",
          "chart-drag-export",
          "drawing-tool-change",
          "replay-change",
          "customization-change",
          "action-run",
          "data-error",
          "trading-intent",
          "trading-line-change",
          "price-axis-action",
          "markers-change",
          "marker-click",
          "timescale-mark-click",
          "market-events-change",
          "market-event-click",
          "market-event-provider-error",
          "market-event-catalog-change",
          "alerts-change",
          "alert-trigger",
          "alert-activate",
          "smart-drawing-state-change",
          "smart-drawing-results-change",
          "smart-drawing-error",
          "bar-click",
          "pane-drag",
          "pane-order-change",
          "pane-layout-change",
          "widget-rail-change",
          "workspace-maximize-change",
          "watchlist-change",
          "tooltip-feature-click",
          "orderflow-heatmap-change",
          "footprint-change",
          "news-refresh-requested",
          "worker-status",
          "worker-execution",
          "state-mutation"
        ]
      },
      "source": {
        "type": "string",
        "minLength": 1,
        "maxLength": 9,
        "enum": [
          "chart",
          "workspace",
          "widget"
        ]
      },
      "chartId": {
        "type": "string",
        "maxLength": 256
      },
      "payload": {
        "type": "json",
        "maxDepth": 16,
        "maxArrayItems": 10000,
        "maxObjectProperties": 256,
        "maxStringLength": 32768,
        "maxTotalNodes": 50000
      }
    },
    "required": [
      "type",
      "source",
      "payload"
    ],
    "additionalProperties": false,
    "maxProperties": 4
  },
  "example": {
    "type": "ready",
    "source": "widget",
    "payload": {}
  }
}

widgetBar.statesubscription

Widget rail updates.

• Options: optional; (options?: {})
• Option constraints: None
• Projected event: WidgetBarState
• Controller: widgetBar
• Target scopes: widget
• Access: read
• Family: terminalLayout

Options schema and example

{
  "schema": {
    "type": "object",
    "properties": {},
    "required": [],
    "additionalProperties": false,
    "maxProperties": 0
  },
  "example": {}
}

Projected event schema and example

{
  "schema": {
    "type": "object",
    "properties": {
      "visible": {
        "type": "boolean"
      },
      "activePageId": {
        "type": "string",
        "maxLength": 256
      },
      "pages": {
        "type": "array",
        "items": {
          "type": "json",
          "maxDepth": 16,
          "maxArrayItems": 10000,
          "maxObjectProperties": 256,
          "maxStringLength": 32768,
          "maxTotalNodes": 50000
        },
        "maxItems": 256
      }
    },
    "required": [
      "visible",
      "pages"
    ],
    "additionalProperties": false,
    "maxProperties": 3
  },
  "example": {
    "visible": true,
    "pages": []
  }
}

workspace.eventssubscription

Workspace state and layout events.

• Options: required; (options: { eventTypes: ChartEventType[] })
• Option constraints: None
• Projected event: ChartEvent
• Controller: workspace
• Target scopes: widget
• Access: read
• Family: workspace

Options schema and example

{
  "schema": {
    "type": "object",
    "properties": {
      "eventTypes": {
        "type": "array",
        "items": {
          "type": "string",
          "minLength": 1,
          "maxLength": 29,
          "enum": [
            "ready",
            "symbol-change",
            "interval-change",
            "interval-favorites-change",
            "chart-type-favorites-change",
            "drawing-tool-favorites-change",
            "indicator-favorites-change",
            "chart-type-change",
            "object-change",
            "selection-change",
            "visible-range-change",
            "price-scale-change",
            "price-scale-reset",
            "price-scale-slots-change",
            "crosshair-change",
            "display-settings-change",
            "user-settings-change",
            "indicator-change",
            "comparison-change",
            "drawings-change",
            "drawing-sharing-change",
            "layout-change",
            "active-chart-change",
            "template-change",
            "undo-redo-state-change",
            "bar-update",
            "bars-loaded",
            "hover-object-change",
            "dialog-state-change",
            "properties-dialog-change",
            "layout-load-requested",
            "layout-about-to-change",
            "autosave-needed",
            "pane-drag-end",
            "chart-pointer-down",
            "chart-pointer-move",
            "chart-pointer-up",
            "chart-drag-export",
            "drawing-tool-change",
            "replay-change",
            "customization-change",
            "action-run",
            "data-error",
            "trading-intent",
            "trading-line-change",
            "price-axis-action",
            "markers-change",
            "marker-click",
            "timescale-mark-click",
            "market-events-change",
            "market-event-click",
            "market-event-provider-error",
            "market-event-catalog-change",
            "alerts-change",
            "alert-trigger",
            "alert-activate",
            "smart-drawing-state-change",
            "smart-drawing-results-change",
            "smart-drawing-error",
            "bar-click",
            "pane-drag",
            "pane-order-change",
            "pane-layout-change",
            "widget-rail-change",
            "workspace-maximize-change",
            "watchlist-change",
            "tooltip-feature-click",
            "orderflow-heatmap-change",
            "footprint-change",
            "news-refresh-requested",
            "worker-status",
            "worker-execution",
            "state-mutation"
          ]
        },
        "minItems": 1,
        "maxItems": 73
      }
    },
    "required": [
      "eventTypes"
    ],
    "additionalProperties": false,
    "maxProperties": 1
  },
  "example": {
    "eventTypes": [
      "layout-change"
    ]
  }
}

Projected event schema and example

{
  "schema": {
    "type": "object",
    "properties": {
      "type": {
        "type": "string",
        "minLength": 1,
        "maxLength": 29,
        "enum": [
          "ready",
          "symbol-change",
          "interval-change",
          "interval-favorites-change",
          "chart-type-favorites-change",
          "drawing-tool-favorites-change",
          "indicator-favorites-change",
          "chart-type-change",
          "object-change",
          "selection-change",
          "visible-range-change",
          "price-scale-change",
          "price-scale-reset",
          "price-scale-slots-change",
          "crosshair-change",
          "display-settings-change",
          "user-settings-change",
          "indicator-change",
          "comparison-change",
          "drawings-change",
          "drawing-sharing-change",
          "layout-change",
          "active-chart-change",
          "template-change",
          "undo-redo-state-change",
          "bar-update",
          "bars-loaded",
          "hover-object-change",
          "dialog-state-change",
          "properties-dialog-change",
          "layout-load-requested",
          "layout-about-to-change",
          "autosave-needed",
          "pane-drag-end",
          "chart-pointer-down",
          "chart-pointer-move",
          "chart-pointer-up",
          "chart-drag-export",
          "drawing-tool-change",
          "replay-change",
          "customization-change",
          "action-run",
          "data-error",
          "trading-intent",
          "trading-line-change",
          "price-axis-action",
          "markers-change",
          "marker-click",
          "timescale-mark-click",
          "market-events-change",
          "market-event-click",
          "market-event-provider-error",
          "market-event-catalog-change",
          "alerts-change",
          "alert-trigger",
          "alert-activate",
          "smart-drawing-state-change",
          "smart-drawing-results-change",
          "smart-drawing-error",
          "bar-click",
          "pane-drag",
          "pane-order-change",
          "pane-layout-change",
          "widget-rail-change",
          "workspace-maximize-change",
          "watchlist-change",
          "tooltip-feature-click",
          "orderflow-heatmap-change",
          "footprint-change",
          "news-refresh-requested",
          "worker-status",
          "worker-execution",
          "state-mutation"
        ]
      },
      "payload": {
        "type": "json",
        "maxDepth": 16,
        "maxArrayItems": 10000,
        "maxObjectProperties": 256,
        "maxStringLength": 32768,
        "maxTotalNodes": 50000
      }
    },
    "required": [
      "type",
      "payload"
    ],
    "additionalProperties": false,
    "maxProperties": 2
  },
  "example": {
    "type": "layout-change",
    "payload": {}
  }
}

workspaceTabs.statesubscription

Workspace tab updates.

• Options: optional; (options?: {})
• Option constraints: None
• Projected event: WorkspaceTabsChangeEvent
• Controller: workspaceTabs
• Target scopes: widget
• Access: read
• Family: workspace

Options schema and example

{
  "schema": {
    "type": "object",
    "properties": {},
    "required": [],
    "additionalProperties": false,
    "maxProperties": 0
  },
  "example": {}
}

Projected event schema and example

{
  "schema": {
    "type": "object",
    "properties": {
      "tabs": {
        "type": "array",
        "items": {
          "type": "json",
          "maxDepth": 16,
          "maxArrayItems": 10000,
          "maxObjectProperties": 256,
          "maxStringLength": 32768,
          "maxTotalNodes": 50000
        },
        "maxItems": 256
      },
      "activeTabId": {
        "type": "string",
        "maxLength": 256
      }
    },
    "required": [
      "tabs",
      "activeTabId"
    ],
    "additionalProperties": false,
    "maxProperties": 2
  },
  "example": {
    "tabs": [],
    "activeTabId": "layout-1"
  }
}

Related pages

• Controls and Resources — how a client discovers and invokes the controls listed above.
• MCP Security and Access — the access class and policy family behind every row.
• MCP Troubleshooting — what to do when a control is missing, denied, or conflicted.