Type Reference
Search public TypeScript aliases and unions by product area. Interval, chart-type, order, and style vocabularies are expressed as literal unions, with links to the complete declaration and related contracts.
If you are starting a specific integration instead of looking up one type, begin with the domain page:
| Domain | Start with |
|---|---|
| Widget | TradeScript, ChartWidgetOptions, ChartWidgetApi, ChartApi |
| Datafeed | MarketDataFeed, SymbolInfo, Bar |
| Drawings | DrawingDefinition, MarkerDefinition |
| Indicators | IndicatorDefinition, BUILT_IN_INDICATORS |
| Storage | ChartStorageAdapter, ChartLayout, ChartTemplate |
| Trading | TradingBrokerAdapter, order and position contracts |
| Customization | ChartTheme, style settings |
| Events | chart, widget, workspace, market, and alert events |
Search type aliases
Stable machine-readable failures that a customer chat backend or the SDK run loop can report.
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.
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
Which aspect of console state produced a controller event: a host-driven update, or a connection, session, policy, capabilities, or evidence change.
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.
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
The widget renders exactly two templates; every status maps onto one.
The three agentic permission tiers a control belongs to:
'read' for observation, 'write' for non-financial state mutation, and 'trade' for financial authority.Classification of an excluded widget affordance:
'presentational' for purely visual elements with no semantic effect, 'host-only' for affordances owned by the embedding host.Union of a built-in catalog control descriptor and a host-defined custom control descriptor, used wherever discovery and inspection surfaces return controls from both sources.
Universal attachment policy used after an SDK catalog/custom-contract lookup.
Union of a built-in catalog subscription descriptor and a host-defined custom subscription descriptor, used wherever discovery surfaces list channels from both sources.
Alias for
AgenticCatalogControllerId: the exact id of one SDK built-in controller (e.g. chart, data, trading) declared in the agentic catalog.Union of every built-in surface identity the agentic catalog describes: each public widget kind from
AGENTIC_WIDGET_KINDS plus 'terminal'.One canonical reason id from
AGENTIC_CAPABILITY_UNAVAILABLE_REASONS explaining why a control is unavailable on a target, such as not-mounted, provider-unsupported, or policy-denied.Union of the controller identifiers declared in
AGENTIC_CATALOG_CONTROLLER_IDS (e.g. 'chart', 'trading', 'orderTicket'), naming which controller contract owns a control.Union of the built-in agentic widget kinds declared in
AGENTIC_WIDGET_KINDS (e.g. 'chart', 'watchlist', 'order-ticket', 'option-chain'); new public agentic widget kinds must be declared therUnion of the exact SDK-owned constraint-extractor identities, aggregated from the customization/drawing, data-projection, symbol/account, resource, and trade binding modules; an extractor carries publ
Aggregate state/event payloads must explicitly declare independence or exact result filters before they can cross a constrained read boundary.
A source-owned function that narrows one control result, controller state, or subscription event under active policy constraints, receiving the full filter context (subject, args, controller, state, r
A source-owned function that resolves the constrained values for one control invocation from its extraction context (control id, args, controller, state, resources), returning them synchronously or as
Exact catalog-owned location of a constrained value in one public input.
Declares how one policy constraint binds to a control invocation: the constraint id, its value type (string allowlist or finite number), the exact catalog-owned sources of the constrained values withi
One authored batch of controller methods sharing an identical semantic classification — controller, permission family, access class, control family, revision domains, mutation outcome, and risk. Group
Union of every valid agentic control identifier — the read, write, and trade control ids derived from the declared control groups as
controller.method strings.Identifier of a built-in SDK controller from the agentic catalog (an alias of
AgenticBuiltInControllerId); custom controllers use their own host-chosen string ids instead.Union of the two controller registration shapes a surface registration accepts: a built-in catalog controller registration, or a custom controller registration whose generics are erased at runtime onl
Risk classification of a control:
'read' (no mutation), 'write' (non-financial state mutation), or 'financial' (the control can apply financial mutations and carries explicit per-method risk semAccess policy whose read, write, and trade grants may reference host-defined custom control ids in addition to the built-in catalog control ids.
Control descriptor for a custom controller contract: the built-in
AgenticControlDescriptor shape re-keyed with host-chosen control and controller ids, plus optional constraint bindings and a uniformFeature grant for surfaces that expose custom controls:
true or false for all-or-nothing access, or a custom access policy that can grant host-defined control ids alongside the built-in catalog.Subscription-channel descriptor for a custom controller contract: the built-in
AgenticSubscriptionDescriptor shape re-keyed with host-chosen channel and controller ids.Union of the exact market-data domain identifiers used by the
dataDomains policy constraint ('bars', 'l1', 'l2', 'tape', 'sessions', 'instrument-details', 'external-series', 'marks',The subset of
AgenticCapabilityUnavailableReason a controller registration or support authority may declare itself; policy-denied and execution-mode-mismatch are excluded because the SDK derivesUnion of every control-family identifier across the read, write, and trade access classes; each control belongs to exactly one family for family-level permissioning.
Grant used wherever a feature toggles agentic access to built-in controls:
true grants everything the adapter allows, false denies, and an AgenticAccessPolicy grants selectively by class, familyWhether an applied financial mutation is expected to carry a risk decision receipt:
'always' (every source operation requires one), 'never' (none do), or 'conditional' (mixed source operations).Grant for one access class within an
AgenticAccessPolicy: a boolean for all-or-nothing, or an object narrowing by per-family flags, exact per-control flags, and policy constraints, with control flagA JSON-compatible primitive value (
string, number, boolean, or null) forming the leaves of AgenticJsonValue.Deeply readonly JSON-compatible value: a primitive, an array, or a string-keyed object. All agentic state, control results, and subscription events are projected to this shape before leaving the in-pr
Exact callable-owned authority for deciding whether a successful invocation applied a state mutation. Registries consume this declaration; they never infer mutation semantics from method names or proj
Identifier of one numeric upper-bound policy constraint (e.g.
maxQuantity, maxHistoryLookbackMs), drawn from AGENTIC_NUMERIC_MAX_CONSTRAINT_IDS. Each id names a finite non-negative ceiling a hosHost-owned opaque namespace for one attached agent/session identity. Invocation boundaries reject empty, whitespace-only, and oversized values.
Identifier of any host-authorable policy constraint: either a string allowlist id (e.g.
symbols, accounts) or a numeric maximum id (e.g. maxNotional). These are the only keys accepted in `AgentiBounded, protocol-neutral schema language used to validate agentic subscription options and events as portable JSON. Every unbounded dimension must be explicitly capped: strings require
maxLength, aIdentifier of a policy constraint whose active value must be explicitly classified by every aggregate state and event projection contract, drawn from
AGENTIC_PROJECTION_CONSTRAINT_IDS. Covers all stClassifies how one public widget component participates in the agentic surface inventory:
direct registers its own agentic target, composed reuses another component's authority, inherited consumIdentifier of a read-class control: either a catalog read operation id (e.g.
chart.getState, plus the projection controls chart.formatPrice, chart.snapshot, and widget.snapshot) or a `subscripIdentifier of one read permission family (e.g.
chart, marketData, trading, risk), drawn from AGENTIC_READ_FAMILY_IDS. Access policies may grant or deny whole families before refining individIdentifier of one SDK-owned result-filter function used to narrow readable results under active policy constraints, drawn from the merged
AGENTIC_RESULT_FILTER_IDS inventory. Descriptors reference fRevision-domain identifier used to guard and report agent-authored mutations.
Chart domains plus revision domains owned by standalone trading widgets.
Session-attachment access: flat grants applying to every surface, optionally narrowed per surface kind via
surfaces. Wherever a request accepts sessionAccess, the per-kind entry for the resolved tIdentifier of one string-allowlist policy constraint (e.g.
symbols, accounts, drawingKinds), drawn from AGENTIC_STRING_ALLOWLIST_CONSTRAINT_IDS. Each id names a set of exact string values a hoIdentifier of one built-in subscription channel declared in
AGENTIC_SUBSCRIPTION_CATALOG (e.g. data.bars, trading.events, replay.state). These are the canonical semantic identities for controlBinds one policy constraint (string allowlist or finite-number maximum) to the exact locations of its values inside a subscription's options object. Restricted to non-authority value sources, so subsc
Location of one constrained value inside subscription options: any
AgenticConstraintValueSource variant except authority extractors (literal, argument, property, object-leaf-paths, array-length, rThe contract portion of a subscription authority (
optionsContract and eventContract) without the channel id, mixed into AgenticSubscriptionDescriptor so catalog descriptors carry their own portaSynthetic read-control identifier of the form
subscription:<channelId> used to grant or deny one subscription channel inside an access policy, produced by getAgenticSubscriptionPolicyControlId.Availability of one controller or subscription binding on a built-in surface:
registered is always mounted with the surface, conditional exists only when the mounted configuration declares it (e.gSurface lifecycle event delivered to adapter-level subscribers: a surface was
registered or unregistered, carrying its public descriptor.Categorical reason a controller method is not exposed as an agentic control: it is an accessor, callback registration, cleanup, DOM access, live browser handle, host-lifecycle operation, provider regi
Kind of a built-in agentic surface: the whole
session, a terminal, or one of the catalog widget kinds.Declares one semantic capability of a built-in surface as either a bound controller (
kind: 'controller') or a bound event channel (kind: 'subscription'), each with an availability classification aIdentifier of a controller with a declared symbol/account state projection contract: either one of the filtered controllers or one of the four symbol/account-independent controllers. These are the val
Addressing scope of an agentic target:
session for the shared session surface, chart for one mounted chart, or widget for one mounted widget. Controllers declare which scopes they can be registeIdentifier of one trade-class (financial) control derived from the catalog control groups, in
controller.method form (e.g. trading.placeOrder). Trade controls require an explicit trade grant with Identifier of one trade permission family (
orders, positions, leverage, or emergency), drawn from AGENTIC_TRADE_FAMILY_IDS. Trade grants may enable or disable whole families before refining Classification of one semantic UI affordance in the built-in surface inventory: agent-operable entries are
callable-control, observable-state, or subscription, while reviewed exclusions are `preOne SDK-owned classification decision for a semantic UI affordance. Control, state, and stream entries come only from an explicit built-in surface binding; presentational and host-only entries come on
One explicit SDK-owned portability boundary. Projection happens before a state, result, or event leaves the in-process adapter; transports only apply generic size/depth limits to the resulting JSON va
Per-widget agentic feature grant: a boolean for all-or-nothing access, or an access policy optionally scoped to one widget
instanceId.Kind identifier of a built-in widget surface, drawn from the agentic widget catalog (an alias of
AgenticCatalogWidgetKind).Identifier of one write-class (non-financial mutation) control derived from the catalog control groups, in
controller.method form (e.g. chart.setSymbol).Identifier of one write permission family (e.g.
drawings, indicators, orderEntry, customization), drawn from AGENTIC_WRITE_FAMILY_IDS. Access policies may grant or deny whole families beforeWhy one strategy clause cannot yet be activated.
How the human is conversing with the strategy agent.
Exact approval target echoed from the rendered snapshot.
Presentation-neutral strategy lifecycle status supplied by the host. The widget renders this status but does not derive, advance, or repair the strategy lifecycle.
A delivery hint the host/provider acts on. The SDK never sends email/sms itself.
What an alert watches.
price-* and percent-change are evaluated by the SDK's built-in evaluator against the loaded symbol; drawing-cross / indicator / expression are evaluated by an injectedHow often an armed alert may fire.
Callback an
AlertProvider.subscribe implementation invokes to push provider-driven events — out-of-band alert creates/updates/removes and provider-evaluated triggers — back into the SDK.Event pushed through an
AlertProvider subscription: a created/updated/removed change carrying the affected alert record, or a triggered event carrying the full AlertTriggerContext.Lifecycle state of an alert. Provider/host-driven; the SDK renders it.
Asset-class classification carried on
SdkSymbolInfo.type, spanning equities, indices, forex, futures, crypto, options, funds, and prediction/event-contract markets, with unknown as the fallback.Category of chart change that marks the chart dirty for auto-save, accumulated into
AutoSaveNeededPayload.reasons: symbol/interval switches, drawing, indicator, and comparison edits, display-settingGiven the current entries and the configured limits, return the keys to evict. Built-ins below cover LRU/LFU/FIFO; supply your own for size-, byte-, or pin-aware strategies (e.g. a prop firm keeping c
-
none: no caching, pure passthrough to the inner feed. - memory: in-session cache only, lost on reload. - persistent: in-session cache backed by a store (IndexedDB by default).Per-interval TTL override in ms, or a single ms value for all intervals.
Renderer-neutral DOM extension used for an order-info label or value.
Declarative order-info row backed by a calculated source or host-owned value extension.
Account-action-dialog options that remain host-configurable inside a composed terminal.
Account-panel options that remain host-configurable inside a composed terminal.
Account-summary options that remain host-configurable inside a composed terminal.
Backend-neutral Agent Chat options hosted inside the terminal layout. Omitting the provider leaves model selection, composition, and sending disabled and causes no discovery, network, or fallback egre
Agent Console options hosted inside the terminal's own layout and hotkey authority.
Chart options that remain host-configurable inside a composed terminal.
Related pages
- Interfaces — the interfaces and classes these aliases appear in.
- Enumerations and Constants — the runtime catalog values behind the literal unions.
- API Catalog — the same surface organized by product area.