All commands output via a unified JSON envelope:{"ok": true, "data": ..., "error": null, "meta": {...}}。
Reference files:
references/output-schema.md—MonitorResult、FocusItem、LiveScanResult、LiveFocusItemcomplete field descriptionsreferences/signal-strategy.md— signal types, strength rules, auxiliary factor interpretation, indicator definitions
Quick index
| Requirement | Command |
|---|---|
| Market quotes | stk market |
| News | stk market news |
| Technical ranking | stk stock rank |
| Industry hotspots | stk stock hotspot |
| Stock selection candidates | stk stock candidates |
| Individual stock scan | stk stock scan <symbols...> |
| Live alerts | stk stock scan-live <symbols...> |
| K-line/indicators | stk stock kline <symbols...> |
| Fundamentals | stk stock fundamental <symbol> |
| Watchlist management | stk watchlist list/show/create/add/remove/delete |
| Watchlist scan | stk watchlist scan <group> |
| Watchlist live | stk watchlist scan-live <group> |
| Watchlist K-line | stk watchlist kline <group> |
| Health check | stk doctor check |
| Clear cache | stk cache clear |
Market
stk market
Market overview, indices grouped by CN / HK / US , including temperature for the three regions.
Returns MarketOverview:indices(symbol、name、region、last、change、change_pct、volume)、temperature(score、level、valuation、sentiment)。
stk market news
Global news, merging CLS + THS in reverse chronological order.
| Parameter | Default | Description |
|---|---|---|
--source |
all |
all / cls / ths |
--count |
20 |
Count |
--filter |
全部 |
CLS:全部 / 重点 |
Returns NewsItem[]:title、summary、published_at、source、url。
Stock
stk stock rank
THS technical screen ranking.
| Parameter | Default | Description |
|---|---|---|
--screen -s |
lxsz |
lxsz / cxfl / xstp / ljqs / cxsl / lxxd / xxtp / ljqd |
--ma |
20日均线 |
xstp / xxtp dedicated |
Returns TechRank:type、label、items[](code、name、metrics)。
stk stock hotspot
Industry bullish/bearish sentiment statistics.
| Parameter | Default | Description |
|---|---|---|
--ma |
20日均线 |
xstp / xxtp dedicated |
Returns TechIndustries:industries[](industry、bull_count、bear_count、bull_screens、bear_screens)。
stk stock candidates
Cross-screen candidate stocks, returning stocks that appear in ≥2 bullish screens.
| Parameter | Default | Description |
|---|---|---|
--ma |
20日均线 |
xstp / xxtp dedicated |
Returns TechCandidates:candidates[](code、name、bull_screens)、total。
candidatesis a technical preliminary screen and does not represent trend confirmation; you need to continuestk stock scan <symbols...>。
stk stock scan <symbols...>
Daily individual stock monitoring scan.
stk stock scan 600519 000001 700.HK
stk stock scan 600519 --daily10
stk stock scan 600519 --full-context
| Parameter | Default | Description |
|---|---|---|
--daily10 |
false |
Strong-signal targets supplemented with the most recent 10 daily bars |
--full-context |
false |
Output complete auxiliary factors (including neutral/none) |
Returns MonitorResult:run_date、universe、summary、focus[]、ignored、errors[]。focus[] contains decision、primary_signal、context、risk, see detailed fields in references/output-schema.md。
stk stock scan-live <symbols...>
Live alert scan. Daily filter + 5m/15m K-line trigger determination.
stk stock scan-live 600519 300750
stk stock scan-live 600519 --timeframe 5m
| Parameter | Default | Description |
|---|---|---|
--timeframe -t |
15m |
5m / 15m |
--count -c |
80 |
Number of minute K-line bars |
Returns LiveScanResult:mode、as_of、timeframe、summary、focus[]、ignored、errors[]。focus[] contains daily_signal、live_signal、trigger、risk_line、vwap、ema20、rsi14, see detailed fields in references/output-schema.md。
stk stock kline <symbols...>
K-line + all technical indicators.
| Parameter | Default | Description |
|---|---|---|
--type -t |
stock |
stock / index |
--period -p |
day |
day / week / month |
--count -c |
20 |
Number of K-line bars |
Returns DailyResult[]:symbol、days[](OHLCV + change_pct + indicators). Indicators include EMA5/9/10/20/26/60、MACD/signal/hist、RSI、K/D/J(KDJ)、upper/middle/lower(BOLL)、ATR10/ATR14、Supertrend/SupertrendDirection。
stk stock fundamental <symbol>
Peer comparison: valuation, growth, DuPont analysis.
| Parameter | Default | Description |
|---|---|---|
--type -t |
all |
all / growth / valuation / dupont |
Returns FullComparison or IndustryComparison。dupont only for A-shares.
Watchlist
Management commands
| Command | Description |
|---|---|
stk watchlist list |
List all groups |
stk watchlist show <group> |
View group holdings |
stk watchlist create <group> --symbol S ... |
Create group |
stk watchlist add <group> <symbols...> |
Batch add |
stk watchlist remove <group> <symbols...> |
Batch remove |
stk watchlist delete <group> |
Delete group |
stk watchlist scan <group>
Group daily monitoring.
| Parameter | Default | Description |
|---|---|---|
--daily10 |
false |
Append the most recent 10 daily bars |
--full-context |
false |
Output complete auxiliary factors |
Returns MonitorResult, same structure as stk stock scan。
stk watchlist scan-live <group>
Group live alerts.
| Parameter | Default | Description |
|---|---|---|
--timeframe -t |
15m |
5m / 15m |
--count -c |
80 |
Number of minute K-line bars |
Returns LiveScanResult, same structure as stk stock scan-live。
stk watchlist kline <group>
K-lines + indicators for all symbols in the group.
| Parameter | Default | Description |
|---|---|---|
--period -p |
day |
day / week / month |
--count -c |
20 |
Number of K-lines per symbol |
Returns DailyResult[], same structure as stk stock kline。
Tools
| Command | Description |
|---|---|
stk doctor check [--quick] |
Data source health check |
stk cache clear [--prefix PREFIX] |
Clear cache |