/hkexnews/stock_connect/holdings

POST /api/hkexnews/stock_connect/holdings

Price: 20 credits

Stock Connect shareholding on one day: for each eligible security, the shares held in CCASS through Stock Connect, as a percentage of the issued shares (hong_kong) or of the shares listed and traded on the Shanghai or Shenzhen exchange (shanghai, shenzhen). hong_kong covers Hong Kong securities held by Mainland investors; shanghai and shenzhen cover Mainland A shares held by Hong Kong and international investors.

How to use it

Without holding_date you get the latest published day; only about the last 12 months can be queried. Mainland securities carry a CCASS stock code, with the A-share code in a_share_code.

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 securities to return (min: 1)
• market string — Market of the securities held through Stock Connect (default: "hong_kong"; one of: "hong_kong", "shanghai", "shenzhen")
• holding_date integer nullable — Shareholding day, as unix seconds; day-granular (examples: 1759190400)
• stock_code string nullable — Stock code to keep (examples: "00700", "30001"; minLength: 1; maxLength: 6)

Response

• @type string (default: "HkexnewsStockConnectHolding")
• stock_code string required
• stock_name string nullable
• a_share_code string nullable
• shareholding number nullable
• percent_of_issued_shares number nullable
• percent_of_listed_shares number nullable
• holding_date integer nullable
• market 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 — A day outside the published window 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.