/hkexnews/ccass/holdings

POST /api/hkexnews/ccass/holdings

Price: 10 credits

CCASS shareholding of one Hong Kong listed security on one day: the totals held by market intermediaries and investor participants, the number of issued shares, and every CCASS participant's holding with its name, address and percentage of issued shares.

How to use it

Without holding_date you get the latest published day. Only about the last 12 months can be queried, so do not pass older days. Pass participant_id to keep a single broker or custodian.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• stock_code string required — HKEX stock code (examples: "00700", "5"; minLength: 1; maxLength: 5; pattern: ^\d+$)
• holding_date integer nullable — Shareholding day, as unix seconds; day-granular (examples: 1759190400)
• participant_id string nullable — CCASS participant id to keep (examples: "C00019", "B01451"; minLength: 1)

Response

• @type string (default: "HkexnewsCcassHoldings")
• stock_code string required
• stock_name string nullable
• holding_date integer nullable
• issued_shares number nullable
• categories array (default: [])
  • @type string (default: "HkexnewsCcassCategory")
  • category string nullable
  • shareholding number nullable
  • participant_count integer nullable
  • percent_of_issued_shares number nullable
• participants array (default: [])
  • @type string (default: "HkexnewsCcassParticipant")
  • participant_id string nullable
  • name string nullable
  • address string nullable
  • shareholding number nullable
  • percent_of_issued_shares number 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 — Unknown stock code, or a day outside the published 12-month 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.