docs: add shareholders, screener, short-trades, rank, stock-events docs + CLI v0.22.0 release notes#1013
Open
hogan-yuan wants to merge 11 commits into
Open
docs: add shareholders, screener, short-trades, rank, stock-events docs + CLI v0.22.0 release notes#1013hogan-yuan wants to merge 11 commits into
hogan-yuan wants to merge 11 commits into
Conversation
…v0.22.0 release notes Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
Corrects response examples and schema tables for 8 API endpoints across
en, zh-CN, and zh-HK locales to match live API responses:
- shareholder_top: object_id is string; percent_shares_held includes % sign;
add percent_shares_changed field; remove non-existent top-level periods array
- shareholder_detail: add name/title/avatar/holding_periods/holding_details/
trading_periods fields; tradings[] has accum_buy/sell/net_buy at period level
- valuation_comparison: symbol -> counter_id; add currency/roe/eps/bps/dps/
div_yld/assets fields; history.date is Unix timestamp
- stock_events: stock.symbol -> stock.code; add counter_id/last_done/market/
logo/trade_status fields; alert_type is integer; next_params is object
- rank_list: add bmp boolean field; symbol -> code; add counter_id/market/
industry fields; chg is ratio not percentage string
- screener_recommend_strategies: id is string; remove average_day_chg/stocks;
add group_type; min/max/value are strings; add tech_data field
- screener_strategy: remove top-level id/name (response is groups only);
add group_type; min/max/value are strings; add tech_data field
- screener_indicators: response is {groups:[]} not {indicators:[]}; replace
value_min/value_max/step with value_ranges/default_range/default_selected/
category/description/places/sub_indicators/tech_indicators
Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
- Renames stock_events.md → top_movers.md across en/zh-CN/zh-HK - Updates slugs: /market/stock-events → /market/top-movers - Updates SDKLinks method: stock_events → top_movers - Updates titles: zh-CN: 异动股票（Top Movers）, zh-HK: 異動股票（Top Movers）, en: Top Movers - Updates all code examples to use the new method names Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
…vers, shareholder_detail, screener_indicators Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
…estamps Replace Unix epoch timestamp strings with RFC 3339 format (e.g. 2022-03-15T04:00:00Z) in response examples and schema descriptions across all three locales (zh-CN, zh-HK, en). 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
SDK documentation and CLI release notes for 13 new APIs. Branch cut from main.
Related SDK PRs: openapi #527, openapi-go #92
New SDK docs (3 locales: zh-CN, zh-HK, en)
FundamentalContext:
shareholder_top,shareholder_detail,valuation_comparisonMarketContext:
stock_events,rank_categories,rank_listQuoteContext:
short_positions(updated to US+HK unified),short_trades(new)New ScreenerContext:
screener_recommend_strategies,screener_user_strategies,screener_strategy,screener_search,screener_indicatorsCLI v0.22.0 release notes
shareholder --top/--object-id,short-trades,compare,top-movers,screener,rankTest plan
autocorrect --lint docs/— No issues ✅🤖 Generated with Claude Code