Chartnaut Docs
What are you looking for?
Questions? The Help agent in Chartnaut answers from these docs in seconds.
Get started
What Chartnaut is, how the pieces fit, plans and the glossary.
- What Chartnaut isChartnaut is a trading terminal you can build into whatever you need: building blocks and agents that shape the charts and everything around them to how you trade.
- How the pieces fitHow Chartnaut turns a trading hunch into an answer: indicators and definitions find the setup, a study measures it, a Forward Insight brings it to your chart, and your own trades complete the picture.
- How to get the most out of ChartnautSix workflows that make Chartnaut worth using, and where to start each one.
- PlansCompare Free, Starter, Pro and Ultra: price, history, live accounts, research limits and the CLI, MCP and API.
- GlossaryEvery Chartnaut term in one line, grouped by where you meet it.
- Keyboard shortcutsSearch with ⌘K and move around Chartnaut with single keys.
- Ways to use ChartnautWays to use Chartnaut, Chartnaut Desktop, Chartnaut in your browser, For developers
Using Chartnaut
Every part of the app, in the order of the app's sidebar.
- TutorialsSet up Charts for how you trade, Connect a broker and place your first trade, Test your first trading idea, Turn your trades into a playbook
- ChartsHow Charts works, Chartbooks, Panels, Chart types
- AccountsHow accounts work, Connect MetaTrader, Connect cTrader, Connect TradeLocker
- Journal and tradesHow your trades are recorded, Dashboard, Trades library, Trade detail
- PlaybooksHow playbooks work, Create a playbook, Tags and criteria, Playbook reports
- BacktestHow backtesting works, Start a session, Session reports
- Definitions and studiesHow research works, Build a definition, Versions and profiles, Run a definition over history
- IndicatorsHow indicators work, Build a custom indicator, Indicators inside definitions
- Views and appsBuild your own pages, Add a view, Views on trades, Views on journal days
- AgentHow the agent works, Work with your data, Approvals, The builders' agents
- CommunityBrowse Discover, add indicators, definitions and apps to your library, clone them to make them yours, and choose who sees your own work.
Scripting
Write and debug indicators, definitions and studies.
- OverviewThis section is the code reference for indicator, definition and study scripts: every declaration, hook and ctx call, with examples you can paste into a builder's Code tab.
- Getting startedOverview, Script anatomy, First indicator guide, First definition guide
- Accuracy and guaranteesWhat Chartnaut guarantees, Bars and clocks, Warmup and memory, Seams and anchors
- Shared runtimeOverview, Price and bar data, Remembering values across bars, Settings inputs and dialog
- Indicator APIOverview, Overlay vs pane, Series types, Panes & scales
- Definition APIOverview, Meta, Events and snapshots, Emit and labels
- Study APIOverview, Declarations, scope, onEvent and onFinish
- AgentsOverview, Indicator authoring agent, Definition authoring agent, Study authoring agent
- TroubleshootingOverview, FAQ, Budget exceeded, Dependency unavailable
CLI, MCP & APIs
Run your scripts from a terminal, a coding agent, an AI app like Claude or ChatGPT, or your own code.
- OverviewRun your indicators, definitions and studies on Chartnaut's servers from a terminal, a coding agent, an AI app over MCP, or your own code. Starter and above.
- InstallInstall the Chartnaut CLI on macOS, Linux or Windows with one command, then update or remove it.
- Sign inConnect the CLI to your account by approving a code in the browser, or with an API key for CI.
- Your first runSet up a folder, write an EMA, validate it, run it on 30 days of BTC and save it.
- Working with Claude Code and CodexWhat chartnaut init gives Claude Code and Codex, the loop they follow, and how they read full results.
- Command referenceEvery chartnaut command and flag, with defaults and limits.
- Saving and versionsPush and pull scripts, resolve version conflicts, and go back to an older version.
- Runs and resultsList runs, compare instruments, and fetch full results, study blocks and CSV, including study runs made in the app.
- Definition eventsRead, filter and export a definition's stored events from the CLI, and run it over more history.
- API keysCreate, scope and revoke the keys the CLI and your own code use to act as you.
- API overviewWhat the Chartnaut API is for, how to authenticate, and a first call to check your key and start a run.
- LimitsHow request, heavy-call, long-poll and runs-at-once limits behave, and how to retry.
- Errors and exit codesEvery API error code, run failure kind and CLI exit code, and which to retry.
- Connect an AI appConnect Chartnaut to an AI app, MCP, the Agent or the CLI, Claude, ChatGPT
- API referenceBase URL, keys, scopes, heavy calls, paging, errors and idempotency, with an index of every endpoint.
Account
Profile, billing, plans and limits, and support.
- ProfileSet your avatar, username, bio and links, and see what you have published.
- Subscription and billingUpgrade, downgrade, cancel or reactivate your plan, and find invoices and usage.
- PreferencesSet the timezone your charts, trades and journal use, and pick a theme.
- SupportAsk the help chat, email support, send feedback and check system status.
- Plans and limitsPlans and limits, Library limits, Definition events, Historical data