Skip to content

docs(fundamental): add business-segments, institution-rating-views, industry-rank, industry-peers, financial-report-snapshot#999

Merged
hogan-yuan merged 8 commits into
mainfrom
feat/fundamental-new-apis-docs
May 20, 2026
Merged

docs(fundamental): add business-segments, institution-rating-views, industry-rank, industry-peers, financial-report-snapshot#999
hogan-yuan merged 8 commits into
mainfrom
feat/fundamental-new-apis-docs

Conversation

@hogan-yuan
Copy link
Copy Markdown
Member

Summary

Adds documentation for 6 new fundamental SDK APIs ported from longbridge-terminal PR #202.

18 files created across zh-CN, zh-HK, and en:

API SDK Method Endpoint
Business Segments business_segments GET /v1/quote/fundamentals/business-segments
Business Segments History business_segments_history GET /v1/quote/fundamentals/business-segments/history
Institutional Rating Views institution_rating_views GET /v1/quote/ratings/institutional
Industry Ranking industry_rank GET /v1/quote/industry/rank
Industry Peer Hierarchy industry_peers GET /v1/quote/industries/peers
Financial Report Snapshot financial_report_snapshot GET /v1/quote/financials/earnings-snapshot

Related PRs

Test plan

  • Preview renders correctly for all 3 locales
  • <SDKLinks> components resolve to correct methods
  • <CliCommand> blocks display expected CLI invocations
  • Response JSON examples and schema tables are accurate

🤖 Generated with Claude Code

hogan-yuan and others added 2 commits May 18, 2026 15:38
…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>
@hogan-yuan hogan-yuan force-pushed the feat/fundamental-new-apis-docs branch from 8b84bca to 041d38e Compare May 18, 2026 07:42
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>
@hogan-yuan hogan-yuan marked this pull request as ready for review May 18, 2026 11:04
hogan-yuan and others added 5 commits May 18, 2026 19:35
…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>
- 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>
@hogan-yuan hogan-yuan merged commit 6109102 into main May 20, 2026
2 checks passed
@hogan-yuan hogan-yuan deleted the feat/fundamental-new-apis-docs branch May 20, 2026 08:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant