/hk01/issues

POST /api/hk01/issues

Price: 5 credits

Get an HK01 (香港01) issue — a curated 專題 dossier that the newsroom keeps updating around one running story (a typhoon, a scam wave, a war, a football tournament). Returns title, teaser, dossier type, owning zone, cover images, article/photo/video counters, timestamps and the list of sections the dossier is split into.

How to use it

Fetch one HK01 issue (專題) by numeric id or /issue/{id} URL. Returns issue_title, teaser, issue_type (特輯 or 議題), zone_id/zone_name/zone_image, image, article_count and sections[] (id + section_title). Feed the same issue id into hk01/issues/articles to pull the dossier contents.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• issue string required — HK01 issue (專題) id or issue URL (examples: "10221", "https://www.hk01.com/issue/10206"; minLength: 1)
• locale string — Content language variant (default: "zh-HK"; one of: "zh-HK", "zh-CN")

Response

• @type string (default: "Hk01Issue")
• id integer required
• issue_title string required
• teaser array (default: [])
• issue_type string nullable
• zone_id integer nullable
• zone_name string nullable
• zone_image string nullable
• web_url string nullable
• image string nullable
• original_image string nullable
• article_count integer nullable
• image_count integer nullable
• video_count integer nullable
• is_featured boolean (default: false)
• is_sponsored boolean (default: false)
• published_at integer nullable
• updated_at integer nullable
• sections array (default: [])
  • @type string (default: "Hk01IssueSection")
  • id integer required
  • section_title string nullable
  • block_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 — Issue not found 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.