docs: update screener docs for AI endpoints and new filter/rank features#1036
Merged
Conversation
- CLI screener.md (3 locales): replace quant-scripting content with new
screener subcommand docs covering strategies (--market flag, --all removed),
run <ID> (--page/--count pagination, prevchg desc default, flat items[]
JSON with numeric values), new filter ad-hoc command, and indicators
(flat array JSON output, filter_ prefix stripped)
- rank_list.md (3 locales): document ib_ prefix being optional in --key
and stripped from listing output
- screener_recommend_strategies.md (3 locales): add market parameter,
update endpoint to /v1/quote/ai/screener/strategies/recommend
- screener_user_strategies.md (3 locales): add market parameter,
update endpoint to /v1/quote/ai/screener/strategies/mine
- screener_strategy.md (3 locales): note path-param endpoint
/v1/quote/ai/screener/strategy/{id}
- screener_search.md (3 locales): update endpoint to
/v1/quote/ai/screener/search, normalize response example to items[]
with numeric values
- screener_indicators.md (3 locales): update endpoint to
/v1/quote/ai/screener/indicators, flatten response to array with
tech_values field and no filter_ prefix
Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
…screener, rank; update short-positions and shareholder - short-positions: add HK support and --trades flag (all 3 locales) - shareholder: add --top and --object-id flags (all 3 locales) - short-trades: new command — daily short sale volume for US and HK - compare: new command — cross-stock valuation comparison in fundamentals - top-movers: new command — volatility-based movers with news context - screener: new command — stock screener with strategies and custom filters - rank: new command — LB popularity rankings with composite heat score Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
5 tasks
CLI docs (rank, top-movers, short-trades, screener):
- rank: fix basic usage output to table format; fix rank list columns
(rank/price/chg%/pre_post); fix --key JSON to actual raw API format
with counter_id, last_done, inflow; note both hot_all-us and
ib_hot_all-us are accepted
- top-movers: fix output format to plain table (time/symbol/change%/
reason/tags); remove incorrect "default market US"; fix JSON to raw
API format with events[].stock nested structure
- short-trades: fix column names (nas_short/ny_short/total_vol); fix
JSON to raw API format with counter_id, nus_amount, timestamp fields
- screener: fix screener run JSON (add market field); note filter_
prefix in indicator keys
SDK docs (screener_*):
- screener_recommend_strategies: fix Go market param; fix response key
screeners→strategys; update schema to flat {id,name,type,market}
- screener_user_strategies: same fixes as recommend_strategies
- screener_strategy: fix non-existent CLI command (--id→run ID); fix
response to new AI endpoint shape {filter.filters[{key,min,max}]}
- screener_search: fix page to 0-based; add conditions/show params;
fix Go/Rust/Java signatures; add market field to response schema
- screener_indicators: clarify SDK returns grouped structure, CLI
flattens to array; update response example accordingly
Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
cli/quant/screener.md): replaced quant-scripting content with newscreenersubcommand reference —strategies(removed--all, added--market US|HK|CN|SG),run <ID>(pagination with--page/--count,prevchgdesc default, flatitems[]JSON with numeric values), newfilterad-hoc command, andindicators(flat array JSON,filter_prefix stripped,tech_valuesfield)market/status/rank_list.md): documented thatib_prefix is optional in--keyand is stripped from listing output/v1/quote/ai/screener/..., addedmarketparameter toscreener_recommend_strategiesandscreener_user_strategies, noted path-param URL forscreener_strategy, normalized response examples forscreener_search(items[], numeric values) andscreener_indicators(flat array, nofilter_prefix)Test plan
screener strategies --market HKexample renders correctly in all 3 localesscreener filtersection appears as a new sub-section in CLI docsscreener runJSON output example showsitems[]with numeric valuesrank_listdocs showib_prefix note in all 3 localesscreener_indicatorsresponse example is a flat array🤖 Generated with Claude Code