docs: add shareholders, screener, short-trades, rank, stock-events docs + CLI v0.22.0 release notes by hogan-yuan · Pull Request #1012 · longbridge/developers

hogan-yuan · 2026-05-20T07:08:03Z

Summary

Adds SDK documentation and CLI release notes for 13 new APIs from:

New SDK docs (3 locales each)

FundamentalContext: shareholder_top, shareholder_detail, valuation_comparison

MarketContext: stock_events, rank_categories, rank_list

QuoteContext: hk_short_positions, short_trades

New ScreenerContext: screener_recommend_strategies, screener_user_strategies, screener_strategy, screener_search, screener_indicators

CLI v0.22.0 release notes

Added entries for: shareholder --top/--object-id, short-trades, compare, top-movers, screener, rank.

Related PRs

🤖 Generated with Claude Code

…ndustry-rank, industry-peers, financial-report-snapshot Ported from longbridge-terminal PR #202. Documents 6 new SDK methods across zh-CN, zh-HK, and en: - business_segments — GET /v1/quote/fundamentals/business-segments - business_segments_history — GET /v1/quote/fundamentals/business-segments/history - institution_rating_views — GET /v1/quote/ratings/institutional - industry_rank — GET /v1/quote/industry/rank - industry_peers — GET /v1/quote/industries/peers - financial_report_snapshot — GET /v1/quote/financials/earnings-snapshot Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

Heap was hitting ~10.27GB with 10240MB limit, causing OOM during CI build. Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

…urns percentage (e.g. 56.19) not decimal (e.g. 0.5619)

Document top-movers, rank, short-trades, screener (strategies/search/indicators), compare (valuation), and shareholder --top/--object-id added in the terminal CLI. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

This reverts commit 840c114.

- business_segments/history: date format YYYYMMDD (was YYYYQ#); regionals is [] - institution_rating_views: buy/over/hold/under/sell/total are strings not integers - industry_peers: next[].counter_id is empty string - financial_report_snapshot: ticker without market suffix, date format YYYY.MM.DD, yoy as percentage string, cmp_desc/est_value empty, ratio fields as percentages

…ocales Replace flat `field[].subfield` notation with `∟` nested format for simple structures; use separate `### TypeName` subsections with cross-references for complex/recursive types (IndustryPeers, FinancialReportSnapshot). Fix field types (array→object[], int64→integer), correct date formats (YYYYMMDD not quarter label), and update percent descriptions (percentage not 0–1 decimal). Covers zh-CN, zh-HK, and en for: business_segments, business_segments_history, institution_rating_views, industry_rank, industry_peers, financial_report_snapshot. Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

…v0.22.0 release notes Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

github-actions · 2026-05-20T07:08:27Z


+### [v0.22.0](https://github.com/longbridge/longbridge-terminal/releases/tag/v0.22.0)
+
+- **新增 `shareholder --top`** — 前20大股東（機構、個人、內部人）多報告期持股對比；`--object-id <id>` 查看單一股東持倉歷史及交易明細


🚫 [AutoCorrect Lint] <AutoCorrect> _{reported by reviewdog 🐶}

Suggested change

- **新增 `shareholder --top`** — 前20大股東（機構、個人、內部人）多報告期持股對比；`--object-id <id>` 查看單一股東持倉歷史及交易明細

- **新增 `shareholder --** — 前 20 大股東（機構、個人、內部人）多報告期持股對比；�；`--object-id <id>` 查看單一股東持倉歷史及交易明細

github-actions · 2026-05-20T07:08:28Z

+- **擴展 `short-positions`** — 新增港股支持（`.HK` 自動路由至港交所沽空持倉數據）
+- **新增 `short-trades`** — 每日沽空成交量（美股：FINRA/納斯達克；港股：港交所披露數據）
+- **新增 `compare`** — 多股估值對比（PE/PB/PS/市值/收盤價），不傳對比股票時服務端自動選取同行業標的
+- **新增 `top-movers`** — 價格波動超近20日標準差的異動股票，附關聯新聞解讀；支持 `--market`、`--sort time|change|hot` 篩選


🚫 [AutoCorrect Lint] <AutoCorrect> _{reported by reviewdog 🐶}

Suggested change

- **新增 `top-movers`** — 價格波動超近20日標準差的異動股票，附關聯新聞解讀；支持 `--market`、`--sort time|change|hot` 篩選

- **新增 `top-mov** — 價格波動超近 20 日標準差的異動股票，附關聯新聞解讀；支持�持 `--market`、`--sort time|change|hot` 篩選

github-actions · 2026-05-20T07:08:28Z

+        "second_tags": [
+          { "key": "ib_hot_all-us", "name": "美股總熱度", "market": "US" },
+          { "key": "ib_hot_all-hk", "name": "港股總熱度", "market": "HK" },
+          { "key": "ib_hot_all-cn", "name": "A股總熱度", "market": "CN" }


🚫 [AutoCorrect Lint] <AutoCorrect> _{reported by reviewdog 🐶}

Suggested change

{ "key": "ib_hot_all-cn", "name": "A股總熱度", "market": "CN" }

{ "key": "ib_hot_all-cn", "name": "A 股總熱度", "market": "CN" }

github-actions · 2026-05-20T07:08:28Z

+headingLevel: 2
+---
+
+獲取價格波動超過近20個交易日標準差的異動股票，系統自動關聯相關新聞解讀異動原因。


🚫 [AutoCorrect Lint] <AutoCorrect> _{reported by reviewdog 🐶}

Suggested change

獲取價格波動超過近20個交易日標準差的異動股票，系統自動關聯相關新聞解讀異動原因。

獲取價格波動超過近 20 個交易日標準差的異動股票，系統自動關聯相關新聞解讀異動原因。

github-actions · 2026-05-20T07:08:28Z

+        "alert_type": "earnings_beat",
+        "post": {
+          "id": "post_abc123",
+          "title": "阿里巴巴Q4財報解讀：雲業務強勁增長",


🚫 [AutoCorrect Lint] <AutoCorrect> _{reported by reviewdog 🐶}

Suggested change

"title": "阿里巴巴Q4財報解讀：雲業務強勁增長",

"title": "阿里巴巴 Q4 財報解讀：雲業務強勁增長",

github-actions · 2026-05-20T07:08:28Z

+- **扩展 `short-positions`** — 新增港股支持（`.HK` 自动路由至港交所沽空持仓数据）
+- **新增 `short-trades`** — 每日沽空成交量（美股：FINRA/纳斯达克；港股：港交所披露数据）
+- **新增 `compare`** — 多股估值对比（PE/PB/PS/市值/收盘价），不传对比股票时服务端自动选取同行业标的
+- **新增 `top-movers`** — 价格波动超近20日标准差的异动股票，附关联新闻解读；支持 `--market`、`--sort time|change|hot` 筛选


🚫 [AutoCorrect Lint] <AutoCorrect> _{reported by reviewdog 🐶}

Suggested change

- **新增 `top-movers`** — 价格波动超近20日标准差的异动股票，附关联新闻解读；支持 `--market`、`--sort time|change|hot` 筛选

- **新增 `top-mov** — 价格波动超近 20 日标准差的异动股票，附关联新闻解读；支持�持 `--market`、`--sort time|change|hot` 筛选

github-actions · 2026-05-20T07:08:28Z

+        "second_tags": [
+          { "key": "ib_hot_all-us", "name": "美股总热度", "market": "US" },
+          { "key": "ib_hot_all-hk", "name": "港股总热度", "market": "HK" },
+          { "key": "ib_hot_all-cn", "name": "A股总热度", "market": "CN" }


🚫 [AutoCorrect Lint] <AutoCorrect> _{reported by reviewdog 🐶}

Suggested change

{ "key": "ib_hot_all-cn", "name": "A股总热度", "market": "CN" }

{ "key": "ib_hot_all-cn", "name": "A 股总热度", "market": "CN" }

github-actions · 2026-05-20T07:08:28Z

+headingLevel: 2
+---
+
+获取价格波动超过近20个交易日标准差的异动股票，系统自动关联相关新闻解读异动原因。


🚫 [AutoCorrect Lint] <AutoCorrect> _{reported by reviewdog 🐶}

Suggested change

获取价格波动超过近20个交易日标准差的异动股票，系统自动关联相关新闻解读异动原因。

获取价格波动超过近 20 个交易日标准差的异动股票，系统自动关联相关新闻解读异动原因。

github-actions · 2026-05-20T07:08:28Z

+        "alert_type": "earnings_beat",
+        "post": {
+          "id": "post_abc123",
+          "title": "阿里巴巴Q4财报解读：云业务强劲增长",


🚫 [AutoCorrect Lint] <AutoCorrect> _{reported by reviewdog 🐶}

Suggested change

"title": "阿里巴巴Q4财报解读：云业务强劲增长",

"title": "阿里巴巴 Q4 财报解读：云业务强劲增长",

github-actions · 2026-05-20T07:08:28Z

+headingLevel: 2
+---
+
+获取上市公司前20大股东（机构、个人、内部人）的持股数据，支持多报告期对比。`object_id` 可传入 `shareholder_detail` 查看详情。


🚫 [AutoCorrect Lint] <AutoCorrect> _{reported by reviewdog 🐶}

Suggested change

获取上市公司前20大股东（机构、个人、内部人）的持股数据，支持多报告期对比。`object_id` 可传入 `shareholder_detail` 查看详情。

获取上市公司前 20 大股东（机构、个人、内部人）的持股数据，支持多报告期对比。`object_id` 可传入 `shareholder_detail` 查看详情。

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

hogan-yuan · 2026-05-20T08:23:23Z

Superseded by #1013 — new branch cut from main

hogan-yuan and others added 10 commits May 18, 2026 15:38

ci: re-trigger CI check

041d38e

chore(build): increase Node.js heap limit to 12GB

a153705

Heap was hitting ~10.27GB with 10240MB limit, causing OOM during CI build. Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

fix(docs): correct business_segments percent field examples — API ret…

8987f16

…urns percentage (e.g. 56.19) not decimal (e.g. 0.5619)

cli: Add Notable Commands section with new stock tools

840c114

Document top-movers, rank, short-trades, screener (strategies/search/indicators), compare (valuation), and shareholder --top/--object-id added in the terminal CLI. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Revert "cli: Add Notable Commands section with new stock tools"

a6871b0

This reverts commit 840c114.

docs: add sdk docs for shareholders/screener/short-trades/rank + CLI …

bbbf6c6

…v0.22.0 release notes Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

docs: add screener _category_.json for en and zh-HK

aaa5dcd

github-actions Bot reviewed May 20, 2026

View reviewed changes

hogan-yuan and others added 2 commits May 20, 2026 15:56

docs: merge hk_short_positions into short_positions (US+HK unified)

05d946a

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

fix(docs): add spaces between Chinese and numbers per autocorrect rules

9f9bc83

hogan-yuan closed this May 20, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: add shareholders, screener, short-trades, rank, stock-events docs + CLI v0.22.0 release notes#1012

docs: add shareholders, screener, short-trades, rank, stock-events docs + CLI v0.22.0 release notes#1012
hogan-yuan wants to merge 12 commits into
mainfrom
feat/shareholders-screener-short-trades-rank

hogan-yuan commented May 20, 2026

Uh oh!

github-actions Bot May 20, 2026

Uh oh!

github-actions Bot May 20, 2026

Uh oh!

github-actions Bot May 20, 2026

Uh oh!

github-actions Bot May 20, 2026

Uh oh!

github-actions Bot May 20, 2026

Uh oh!

github-actions Bot May 20, 2026

Uh oh!

github-actions Bot May 20, 2026

Uh oh!

github-actions Bot May 20, 2026

Uh oh!

github-actions Bot May 20, 2026

Uh oh!

github-actions Bot May 20, 2026

Uh oh!

hogan-yuan commented May 20, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant


		### [v0.22.0](https://github.com/longbridge/longbridge-terminal/releases/tag/v0.22.0)

		- 新增 `shareholder --top` — 前20大股東（機構、個人、內部人）多報告期持股對比；`--object-id <id>` 查看單一股東持倉歷史及交易明細

	- 新增 `shareholder --top` — 前20大股東（機構、個人、內部人）多報告期持股對比；`--object-id <id>` 查看單一股東持倉歷史及交易明細
	- 新增 `shareholder -- — 前 20 大股東（機構、個人、內部人）多報告期持股對比；�；`--object-id <id>` 查看單一股東持倉歷史及交易明細

	- 新增 `top-movers` — 價格波動超近20日標準差的異動股票，附關聯新聞解讀；支持 `--market`、`--sort time\|change\|hot` 篩選
	- 新增 `top-mov — 價格波動超近 20 日標準差的異動股票，附關聯新聞解讀；支持�持 `--market`、`--sort time\|change\|hot` 篩選

	{ "key": "ib_hot_all-cn", "name": "A股總熱度", "market": "CN" }
	{ "key": "ib_hot_all-cn", "name": "A 股總熱度", "market": "CN" }

	獲取價格波動超過近20個交易日標準差的異動股票，系統自動關聯相關新聞解讀異動原因。
	獲取價格波動超過近 20 個交易日標準差的異動股票，系統自動關聯相關新聞解讀異動原因。

	"title": "阿里巴巴Q4財報解讀：雲業務強勁增長",
	"title": "阿里巴巴 Q4 財報解讀：雲業務強勁增長",

	- 新增 `top-movers` — 价格波动超近20日标准差的异动股票，附关联新闻解读；支持 `--market`、`--sort time\|change\|hot` 筛选
	- 新增 `top-mov — 价格波动超近 20 日标准差的异动股票，附关联新闻解读；支持�持 `--market`、`--sort time\|change\|hot` 筛选

	{ "key": "ib_hot_all-cn", "name": "A股总热度", "market": "CN" }
	{ "key": "ib_hot_all-cn", "name": "A 股总热度", "market": "CN" }

	获取价格波动超过近20个交易日标准差的异动股票，系统自动关联相关新闻解读异动原因。
	获取价格波动超过近 20 个交易日标准差的异动股票，系统自动关联相关新闻解读异动原因。

	"title": "阿里巴巴Q4财报解读：云业务强劲增长",
	"title": "阿里巴巴 Q4 财报解读：云业务强劲增长",

	获取上市公司前20大股东（机构、个人、内部人）的持股数据，支持多报告期对比。`object_id` 可传入 `shareholder_detail` 查看详情。
	获取上市公司前 20 大股东（机构、个人、内部人）的持股数据，支持多报告期对比。`object_id` 可传入 `shareholder_detail` 查看详情。

Conversation

hogan-yuan commented May 20, 2026

Summary

New SDK docs (3 locales each)

CLI v0.22.0 release notes

Related PRs

Uh oh!

github-actions Bot May 20, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot May 20, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot May 20, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot May 20, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot May 20, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot May 20, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot May 20, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot May 20, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot May 20, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot May 20, 2026

Choose a reason for hiding this comment

Uh oh!

hogan-yuan commented May 20, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant