Read HKEx Filing
get_filingRead-onlyIdempotent
Download one HKEx document by its URL and read, page through, or search its text.
``link`` must be an HKEx document URL from search_filings (host ``www1.hkexnews.hk``);
any other host is rejected. With ``extract=True`` (default) the response includes up to
30 ``tables`` and a window of extracted ``document_text``: ``max_chars`` characters
starting at ``offset``. Long reports return ``next_offset``; call again with it to read
the next window. Pass ``query`` to search the whole document instead: the response then
lists up to 20 case-insensitive matches with their offsets and surrounding text, plus
``match_count`` — use a match offset to read that part. Set ``extract=False`` for size
and content type only.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| link | Yes | HKEx document URL from a search_filings result (host www1.hkexnews.hk) | |
| query | No | Optional text to find in the whole document; returns matches with offsets instead of a text window | |
| offset | No | Character offset where the returned text window starts (use next_offset to page) | |
| extract | No | Extract text and tables; false returns size and content type only | |
| max_chars | No | Maximum characters of document_text to return in this window |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes | The downloaded document, with text and tables when extract is true. |