# Lumen Charts documentation Public integration documentation for a proprietary library. Runtime access is separately authorized. Exported API signatures do not imply that all legacy capabilities are supported; preserve compatibility notes when using these documents. # Charting Library Lumen Charts is a standalone proprietary charting product. Add interactive financial charts to your web app, powered by your own data. Lumen Charts gives you the browser runtime, chart controls, drawings, indicators and APIs for saving and loading. Your app brings the market data, sign-in and storage. ## Choose your path | I want to… | Start here | | --- | --- | | Show my first chart | [Your first chart](https://docs.lumencharts.com/charting-library/getting-started/quickstart) | | Use React, Vue or Nuxt | [Lifecycle and frameworks](https://docs.lumencharts.com/charting-library/getting-started/lifecycle#framework-integrations) | | Feed in historical and live prices | [Datafeed contract](https://docs.lumencharts.com/charting-library/datafeed) | | Match my product's look | [Themes and UI](https://docs.lumencharts.com/charting-library/configuration/themes) | | Save and restore a user's analysis | [Saving and loading](https://docs.lumencharts.com/charting-library/persistence) | | Add automation or AI-assisted workflows | [AI integration](https://docs.lumencharts.com/charting-library/automation/) | | Let users trade from the chart | [Trading](https://docs.lumencharts.com/charting-library/trading/) | | Look up a method or type | [API reference](https://docs.lumencharts.com/charting-library/api/) | | Fix something that isn't working | [Troubleshooting](https://docs.lumencharts.com/charting-library/reference/troubleshooting) | | Try it right now | [Examples](https://docs.lumencharts.com/examples/) or the [interactive demo](https://docs.lumencharts.com/demo/) | ## Get started You need three things to see a chart: the runtime files on a web server, a container with a real height, and a datafeed. It's fine to begin with sample data and swap in your own service later. 1. [Get and host the runtime](https://docs.lumencharts.com/charting-library/getting-started/installation). 2. [Show your first chart](https://docs.lumencharts.com/charting-library/getting-started/quickstart). 3. [Connect your market data](https://docs.lumencharts.com/charting-library/datafeed). 4. [Clean up when the view closes](https://docs.lumencharts.com/charting-library/getting-started/lifecycle). 5. [Save layouts](https://docs.lumencharts.com/charting-library/persistence). The [demo](https://docs.lumencharts.com/demo/) needs no sign-in. The examples use a fixed sample period in UTC, not live market prices. ## How it fits into your app The widget you create adds an iframe that holds the chart and its controls. Your datafeed sends bars to the chart through callbacks. The public widget and chart APIs give you commands and event subscriptions. Pine, native automation and trading are optional and load from separate assets. Your application supplies AI providers, the broker connection, uploads, account access and other hosted services. Call the public API once its ready callback fires. Avoid reaching into iframe globals, canvas state or internal model objects; they can change without notice. When the view that hosts the chart goes away, remove the widget. ## What's in scope The runtime supports a focused set of compatible features. The type declarations also include some legacy interfaces, and those are not a promise that the behavior works. The [compatibility guide](https://docs.lumencharts.com/charting-library/reference/compatibility) explains how to tell them apart. The runtime does not include a broker connection, an exchange feed or a hosted storage service with sign-in. [Trading](https://docs.lumencharts.com/charting-library/trading/) connects to a broker through an adapter you write. [Start building →](https://docs.lumencharts.com/charting-library/getting-started/quickstart) --- Documentation page: https://docs.lumencharts.com/charting-library/ --- # LLM resources Want help from an AI assistant? These exports give it the same public docs you're reading here. To share a single article, use **Copy for LLM** or **Download Markdown** under its title. ## Complete documentation - [Download all documentation as Markdown](https://docs.lumencharts.com/markdown/all.md) — all public guides, API reference and examples in one file, approximately 2 MB. - [View the LLM documentation index](https://docs.lumencharts.com/llms.txt) — the pages to start with, common integration mistakes, then every guide with a one-line summary, in reading order. - [View the complete documentation as text](https://docs.lumencharts.com/llms-full.txt) — the same full content in a plain-text file. The full export may be too big for some AI tools. If so, start with the section for your task, then add the API pages it links to. ## Section exports | Section | Markdown | | --- | --- | | Overview | [Download overview](https://docs.lumencharts.com/markdown/sections/overview.md) | | Getting started | [Download getting started](https://docs.lumencharts.com/markdown/sections/getting-started.md) | | Connect data | [Download datafeed guides](https://docs.lumencharts.com/markdown/sections/datafeed.md) | | Configure the chart | [Download configuration guides](https://docs.lumencharts.com/markdown/sections/configuration.md) | | Drawings | [Download drawing guides](https://docs.lumencharts.com/markdown/sections/drawings.md) | | Indicators and Pine | [Download indicator guides](https://docs.lumencharts.com/markdown/sections/studies.md) | | Save and restore | [Download saving guides](https://docs.lumencharts.com/markdown/sections/persistence.md) | | AI integration | [Download AI integration guides](https://docs.lumencharts.com/markdown/sections/automation.md) | | Reference | [Download reference guides](https://docs.lumencharts.com/markdown/sections/reference.md) | | Examples | [Download examples](https://docs.lumencharts.com/markdown/sections/examples.md) | | Demo | [Download demo documentation](https://docs.lumencharts.com/markdown/sections/demo.md) | | API reference | [Download API reference](https://docs.lumencharts.com/markdown/sections/api.md) | ## What is included Exports include the public guides, API signatures and integration examples. Interactive charts are replaced with links to the browser examples. Compatibility notes are kept, because they're part of the API contract: a legacy declaration doesn't guarantee that a feature is available. Library source files, runtime downloads, source maps and private repository documents are never included. Access to the runtime is still [authorized separately](https://docs.lumencharts.com/charting-library/getting-started/installation). `llms.txt` helps AI tools find these docs, but there's no guarantee a given tool will read it automatically. If needed, give the tool the document or its URL directly. --- Documentation page: https://docs.lumencharts.com/charting-library/llm-resources