API Catalog
Use this catalog when you know the capability or TypeScript symbol you need. If you are implementing a workflow, start with a task guide — Quickstart, Datafeeds, Trading, Storage, and Customization — then return here for exact signatures.
Every result is searchable and linkable. Expand a symbol to see its declaration, properties, methods, parameters, return values, and errors.
Choose a product area
| Product area | Contracts |
|---|---|
| Widget | These contracts mount charts and standalone surfaces in any framework, and expose the controllers that drive them once mounted. |
| Datafeed | These contracts define everything the chart asks of a market-data feed: symbols, historical bars, realtime updates, sessions, quotes, and depth. |
| Drawings | These contracts define a drawing, its handles and tool, and the lifecycle that creates, updates, and removes it. |
| Indicators | These contracts help you add, configure, and manage built-in and custom indicators in a chart. |
| Storage | These contracts persist chart workspace state and the separate widget panel arrangements around charts, plus templates, drawings, images, replay state, and user settings. |
| Trading | These contracts connect a broker to the chart: the adapter itself, the order, position, execution, and account state it publishes, and the trading UI that renders them. |
| Customization | These contracts control everything a reader sees: themes, styles, typed overrides, toolbars, menus, localization, and accessibility. |
| Events | These contracts carry every signal the chart emits — widget, chart, alert, workspace, and market events — and the subscriptions that receive them. |
Specialist catalogs
- Advanced API — diagnostics, worker control, computation, and caching for integrations that need lower-level control.
Related pages
- Quickstart — mount a chart before reaching for exact signatures.
- Errors — the error codes these contracts raise.
- Feature Gates — which surfaces a licence exposes at runtime.