API Reference
You can view the entire list of types, interfaces, and exports for the library on the Table of Contents page.
If you aren't certain where to start then have a look at the most commonly used interfaces in the next section.
Links to most common interfaces
The most commonly used interfaces
- Widget Constructor Options - ChartingLibraryWidgetOptions / TradingTerminalWidgetOptions
- Widget Methods - IChartingLibraryWidget
- Chart Methods - IChartWidgetApi
- Datafeed JS Api - IExternalDatafeed, IDatafeedChartApi, IDatafeedQuotesApi
- Symbology - LibrarySymbolInfo
Trading Platform commonly used interfaces
- Broker API (without Realtime) - IBrokerWithoutRealtime
- Broker API (with Realtime) - IBrokerTerminal
- Broker Configuration - SingleBrokerMetaInfo
- Trading Host - IBrokerConnectionAdapterHost
Browse the Typescript Definition
Alternatively, if you are more comfortable browsing the API through a Typescript definition file (and especially if you are Visual Studio Code user) then you can browse the API at these links:
Useful keyboard shortcuts
| Action | Windows Shortcut | Mac Shortcut |
|---|---|---|
| Find | ctrl + f | cmd + f |
| Go to Definition | F12 | F12 |
| Go to Definition | ctrl + click | cmd + click |
| Go back | ctrl + - | ctrl + - |