apexstock-skill
v2.0.0
Published
AI coding skill for ApexStock: structured reference docs that help AI assistants (Claude, Cursor, Copilot, etc.) generate correct ApexStock financial-chart code.
Maintainers
Readme
ApexStock AI Skill
AI coding skill for building ApexStock financial / stock charts. Works with Claude Code, Cursor, GitHub Copilot, and any AI coding assistant that can read project context.
Separate skill, one of the ApexCharts ecosystem skills. This is the dedicated skill for ApexStock (
apexstock), shipped as its ownapexstock-skillpackage and repo, distinct from the coreapexcharts-skilland the other product skills. Each product has its own library and skill; use the one that matches yours:| Product | npm library | Skill package & repo | |---|---|---| | ApexCharts, charts |
apexcharts|apexcharts-skill| | ApexGantt, Gantt / timeline |apexgantt|apexgantt-skill| | ApexTree, hierarchy / org charts |apextree|apextree-skill| | ApexSankey, flow / Sankey |apexsankey|apexsankey-skill| | Apex Grid, data grid |apex-grid|apexgrid-skill| | ApexMaps, maps / geo |apexmaps|apexmaps-skill| | ApexStock, financial / stock · this skill |apexstock|apexstock-skill|
What This Does
AI models routinely get stock-chart code wrong: forgetting to provide the ApexCharts constructor, using flat o/h/l/c keys instead of the y: [o,h,l,c] array, calling update() on every tick instead of appendData(), or adding a second symbol as another series entry instead of comparison mode. This skill ships structured reference files so the assistant generates correct ApexStock code on the first try.
ApexStock 0.5.0 requires
apexcharts^7.1.0(it was^6.7.0for 0.4.0). This is a breaking change, and the wrappers at 0.2.2 carry it too. The skill leads with it.
Coverage
- OHLC data format,
{ x, y: [open, high, low, close], v? }, chart types, timestamps, normalization, the data adapters (normalize/fromArrays/fromCSV), andexportData/exportImage - Providing ApexCharts, per-instance injection (
{ ApexCharts }), app-widesetApexCharts, or thewindow.ApexChartsglobal - Technical indicators, overlays vs oscillators (multiple oscillator panes since 0.4.0), the full key list incl. VWAP / ATR / Donchian / Keltner,
updateIndicator(key, params)/setIndicatorParams, introspection, custom indicators,calculate*helpers - Real-time streaming,
appendData,view/maxPoints/updateLast, forming-candle recipes, visible-range accessors,aggregateOHLC - Trading overlays, order / stop-loss / take-profit / alert price lines with drag / close / cross callbacks
- Drawings & annotations, the price/time-anchored
addDrawingAPI (trend lines, rays, Fibonacci, measure,snap,registerDrawingTool) and data-space annotations (yLine/yBand/xLine/xBand/point/text) - Comparison mode, multi-instrument overlays with alignment policies, four baseline policies, five modes (absolute / percent / indexed / relative / ratio), the benchmark role, and the
getComparisonStats()leaderboard - Analysis workspace (0.5.0),
getRangeStats/getDrawdown/ the drawdown pane / per-pane heights /measureRangeand the analysis panel /getDataAt/ price-scale modes / the headlessApexStock.statsnamespace - Chart furniture (0.5.0), event markers, the on-chart data legend, toolbar customization, and
ApexStock.sync()for linking independent charts - Events & state,
on/off/once,crosshairMove/rangeChange/rangeChanging/indicatorToggle/drawing*/eventMarker*/priceScaleChange/rangeMeasured/comparison*, andgetState/setState(schema v2 now persists annotations, price lines, event markers, price scale, pane ratios, and the comparison setup) - Export, unified
export()over png / svg / pdf / csv / json, withinclude: ['indicators', 'analysis'] - Theming, light/dark modes, the named preset pack +
registerTheme, and the scoped--apexstock-*token system - Framework wrappers:
react-apexstock,vue-apexstock,ngx-apexstock, incl. theapexChartsinjection prop
Installation
Claude Code
mkdir -p .claude/skills
cd .claude/skills
git clone https://github.com/apexcharts/apexstock-skill.gitCursor / Windsurf
curl -o .cursorrules https://raw.githubusercontent.com/apexcharts/apexstock-skill/main/.cursorrulesGitHub Copilot
Reference SKILL.md in Copilot Chat: @workspace #file:SKILL.md, or paste the contents of .cursorrules into Copilot's custom instructions.
Generic AI Assistant
Paste the contents of SKILL.md into the system prompt or attach it as context.
As an npm dependency
For tools that build on top of this skill (MCP servers, custom AI agents):
npm install apexstock-skillimport { skillFile, referencesDir, referencePath } from 'apexstock-skill';
import { readFile } from 'node:fs/promises';
const skill = await readFile(skillFile, 'utf8');
const streaming = await readFile(referencePath('streaming-and-aggregation.md'), 'utf8');Repository Structure
├── SKILL.md # Main entry point, read this first
├── .cursorrules # Self-contained version for Cursor / Windsurf
├── references/
│ ├── analysis.md # statistics, drawdown, measurements, comparison v2, price scale
│ ├── data-format.md # OHLC points, chart types, adapters, export
│ ├── indicators.md # overlays vs oscillators, keys, params, panes, custom indicators
│ ├── state-and-export.md # getState/setState v2, export() incl. PDF, ApexStock.sync
│ ├── streaming-and-aggregation.md # appendData, forming candle, visible range, aggregateOHLC
│ ├── trading-overlays.md # price lines, annotations, drawings, event markers, legend, toolbar
│ ├── framework-wrappers.md # React, Vue, Angular
│ └── theming.md # light/dark, theme presets, --apexstock-* tokens
└── install/
├── claude-code.md
├── cursor.md
└── copilot.mdLinks
License
MIT
