API Reference
The TradeScript Pro Charts API divides into nine surfaces: chart and standalone surface modules, controller APIs, datafeed contracts, trading contracts, drawing tools, indicator overrides, storage adapters, events, and the type system.
Start from what you are building
| I want to… | Read this first | Then use |
|---|---|---|
| Embed a chart in my app | Quickstart | Widget API, Widget Options |
| Mount standalone widgets in any framework | Framework and Widget Starters | Product Surfaces, Widget API |
| Connect my market data | Datafeeds guide | Datafeed API |
| Add trading (orders, positions, account UI) | Trading quickstart | Trading API |
| Control a mounted chart at runtime | Chart Controller | Chart Events, Widget API |
| Theme and customize the terminal | Customization overview | Customization API |
| Save layouts, drawings, and settings | Storage overview | Storage API |
| Build or configure indicators | Indicators overview | Indicators API, Built-in catalog |
| Verify my integration in a browser | Runtime testing guide | The API page for the product surface under test |
Open the complete API catalog to browse by product area, or search for a symbol below.
Find a symbol
Search interfaces, classes, functions, type aliases, enumerations, and constants, then open the exact declaration and usage notes.
Result of auditing a chart theme's accessible UI tokens against WCAG contrast minimums: every checked foreground/background pair plus the subset that failed.
A failing entry from a theme contrast audit, identical in shape to
AccessibilityContrastResult; collected in AccessibilityContrastAudit.issues.One checked foreground/background token pair from a theme contrast audit, with its computed WCAG contrast ratio and the minimum it was measured against.
Adapt the chart widget's native ten-domain guard without widening it to standalone widget domains. Unsupported domains fail at the boundary.
Adapt an existing SymbolLinkGroup without taking ownership of it.
Placement and initial configuration accepted when adding a built-in catalog indicator to a chart.
Hard upper bound for one user message, including every follow-up tool round.
Controlled access picker. The host must rotate
tools before publishing a new value.One customer-authored access choice displayed by the Agent Chat surface.
Structured browser-safe failure shared by customer providers and the SDK tool-call loop.
Stable machine-readable failures that a customer chat backend or the SDK run loop can report.
Safe, bounded diagnostics attached to a structured Agent Chat failure.
Required fields for constructing a browser-safe Agent Chat error.
Text message authored by the customer or the selected model.
One customer-approved model available through the customer chat backend.
Backend-neutral chat authority supplied by the SDK host.
Conversation item exchanged with the customer chat backend.
Author roles accepted for customer and model-authored chat messages.
Incremental event emitted by a customer-owned Agent Chat provider stream.
Complete input sent to the customer backend for one streamed model turn.
Framework-neutral options accepted by the customer-provider Agent Chat SDK surface.
Access-bound browser authority that validates and executes Agent Chat tool calls.
One validated tool request emitted by the customer-selected model.
JSON-safe tool schema advertised to the customer chat backend and model.
SDK-owned evidence extracted from one successful Agent Chat tool result.
Visible and accessible strings rendered by the Agent Chat surface.
Load state of the agent capability inventory rendered in the console's capabilities disclosure.
Context passed to the host's
renderCapabilities callback: the current capabilities snapshot plus an optional refresh trigger.One link in the connection chain rendered by the agent console, with its own readiness status.
Host-implemented command callbacks the agent console invokes in response to operator actions; each is optional and may complete synchronously or return a promise.
Operator-entered connection details the console forwards to
AgentConsoleCommands.connect.Presentation-ready connection state rendered by the console: the lifecycle status, its host-supplied label, the connection-chain hops, and any error text.
Lifecycle status of the agent connection, from waiting for a terminal through session issuance, pairing, and connection to closed, revoked, or error; every status maps onto either the setup or the con
Host-owned authority consumed by AgentConsoleWidget. Implementations own gateway URLs, fetch/WebSocket work, credential storage, session rotation, policy changes, clipboard behavior, simulation, and e
Which aspect of console state produced a controller event: a host-driven update, or a connection, session, policy, capabilities, or evidence change.
Event delivered to
AgentConsoleControllerApi.subscribe listeners: the change reason, the snapshot revision, and the full resulting snapshot.One row of the console's activity feed: a policy receipt with its verdict, an API call with its success or error outcome, or a collapsed events marker.
One renderable activity feed — the live activity view while connected, or the retained session log shown in the setup template after a session ended. Hosts supply the visible entries plus overflow met
One row of the per-surface grant matrix. Rows come from the host's mounted surfaces.
State of the Grant access section: the per-surface read/write grant matrix plus the paper-trading toggle row. Hosts derive the rows from their mounted surfaces and apply changes through `commands.setG
A host-authored notice rendered by the console — either the setup-template banner (disconnect, revocation, issuance errors) or a secondary strip under the active template (e.g. market-feed failures).
Discriminated union describing the pairing section. Hosted mode moves through loading, ready (endpoint plus nonsecret credential readiness and copyable instructions), error, and revoked states; local
Maps a connection status onto one of the console's two presentation phases.
The widget renders exactly two templates; every status maps onto one.
One suggested-prompt pill shown in the connected template. Clicking the pill copies the host-side prompt text via
commands.copyPrompt(id); an optional Simulate button runs it via `commands.simulatePSession identity rendered in the status row next to the connection label.
Complete read model rendered by AgentConsoleWidget. Presentation-ready values only. Transport credentials entered by the operator never belong in this snapshot.
Framework-neutral options accepted by the Agent Console SDK surface.
The complete set of user-visible strings rendered by
AgentConsoleWidget. Hosts override any subset through the widget's labels prop; unspecified keys fall back to DEFAULT_AGENT_CONSOLE_LABELS.Explicit public-widget semantic inventory. This is intentionally not derived from JSX, callback names, or DOM shape. A visible affordance belongs to a declared controller/stream, a composed surface, o
The canonical reason ids explaining why an agentic control is unavailable on a target:
not-mounted, provider-unsupported, insufficient-data-quality, policy-denied, execution-mode-mismatch, `Identifiers of every SDK controller contract in the agentic catalog, spanning the widget/chart core (widget, chart, timeScale, data) through trading, risk, replay, workspace, and the terminal widget c
Exact ChartApi feature ownership. Every user-operable feature owns at least one standalone semantic control so browser UI and agentic transports share the same authority.
Exact storage ownership for the widget-level saved-layout controller.
Exact storage capability ownership for chart/replay controls.
Exact SDK-owned extractor identities. The bulk symbol/account/resource bindings are intentionally added separately; an extractor becomes public semantic authority only when its exact id is declared he
The complete frozen catalog of agent-callable control descriptors: every classified controller method from the authored control groups plus the projection-backed
chart.formatPrice and chart/widget sExact broad-input contracts implemented by the SDK policy validator. A new binding is authored here; registries and transports never derive one from a method name, argument position, or runtime object
Canonical SDK semantic decisions for callable controller methods. Protocol bridges consume this catalog; they must not classify methods independently.
Exact controller ownership/scope facts shared by every agent transport.
Related pages
- API Catalog — the same surface organized by product area rather than by symbol.
- Widget Options — the mount options every integration starts from.
- Chart Controller — the runtime controller grouped by task.
- Chart Events — the typed event bus and its subscription rules.