/hkexnews/directors/search

POST /api/hkexnews/directors/search

Price: 5 credits

Directors of Hong Kong listed companies from the HKEX directors list: by stock code, every current and former director of the company with capacity, position, appointment and resignation dates; by director name, every listed company where a matching person sits or sat on the board.

How to use it

Pass stock_code for a company's full board history including capacity and dates; a director_name search returns only the person and company names, so follow up with that company's stock_code for the details.

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 directorships to return (min: 1; max: 1000)
• stock_code string nullable — HKEX stock code of the company (examples: "00005", "9988"; minLength: 1; maxLength: 5)
• director_name string nullable — Director name or part of it (examples: "CHAN", "WONG Kwok"; minLength: 2)

Response

• @type string (default: "HkexnewsDirector")
• name string nullable
• name_zh string nullable
• capacity string nullable
• position string nullable
• appointed_date integer nullable
• resigned_date integer nullable
• stock_code string nullable
• company_name string nullable
• company_name_zh string nullable
• listing_status 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 company under that stock_code in the directors list 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.