API Overview

ChartSpire’s public API is organized into three areas:

API	How you use it	What it controls
Extension API	Named imports from `@chartspire/ui`	Register and discover overlays, indicators (`registerIndicator`), and locales
Widget API	`new ChartSpire(options: ChartOptions)` and instance methods	Constructor options, theme, locale, timezone, fonts, multichart, lifecycle
Chart API	`getChart(chartId)` / `getActiveChart()`	One chart: symbol, period, indicators, overlays, panes, viewport, DOM

typescript

import {
  ChartSpire,
  registerIndicator,
  getSupportedOverlays,
} from '@chartspire/ui'
import type { ChartApi } from '@chartspire/ui'
import '@chartspire/ui/style.css'

const chartspire = new ChartSpire({ /* options */ })

// Widget API
chartspire.setTimezone('America/New_York')
chartspire.setLocale('en-US')

// Chart API — specific chart
chartspire.getChart({ id: 'chart2' })?.createIndicator('MA')

// Chart API — active chart
chartspire.getActiveChart()?.scrollToRealTime()

// Extension API
registerIndicator(myCustomIndicator)
console.log(getSupportedOverlays())

API Overview ​

API Overview