/hkexnews/disclosure_of_interests/notices

POST /api/hkexnews/disclosure_of_interests/notices

Price: 5 credits

Disclosure of interests filed with HKEX for one listed corporation since July 2017: notices filed by substantial shareholders, directors and chief executives, or the current lists of substantial shareholders and directors. Each row is the notice's serial number and link, the filer, the reason codes, the shares bought or sold and their average price, and the long, short and lending-pool positions held afterwards.

How to use it

Notices come newest first within each share class. Use the holder-list report types for who holds what; for those lists date_to sets the day they are as at and date_from is not used. Notices filed before 3 July 2017 are not covered. A company with H and A shares returns both classes.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• count integer required — Max number of rows to return (min: 1; max: 2000)
• stock_code string required — HKEX stock code (examples: "00700", "5"; minLength: 1; maxLength: 5; pattern: ^\d+$)
• report_type string — Which disclosure list to return (default: "all_notices"; one of: "all_notices", "substantial_shareholder_notices", "director_notices", "substantial_shareholders", "consolidated_substantial_shareholders", "directors")
• date_from integer nullable — Earliest event day, as unix seconds; day-granular (examples: 1735689600)
• date_to integer nullable — Latest event day, as unix seconds; day-granular (examples: 1759190400)

Response

• @type string (default: "HkexnewsDiNotice")
• id string required
• url string nullable
• stock_code string nullable
• company_name string nullable
• holder_name string nullable
• reasons array (default: [])
  • @type string (default: "HkexnewsDiReason")
  • code string nullable
  • position_type string nullable
• shares_involved array (default: [])
  • @type string (default: "HkexnewsDiShares")
  • position_type string nullable
  • shares number nullable
• currency string nullable
• average_price number nullable
• positions array (default: [])
  • @type string (default: "HkexnewsDiPosition")
  • position_type string nullable
  • shares_interested number nullable
  • percent_of_issued_voting_shares number nullable
• event_date integer nullable
• last_notice_date integer nullable
• associated_corporation_interests string nullable
• debenture_interests string nullable
• report_type string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — No current listed corporation under that stock code Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.