/hk01/issues/articles

POST /api/hk01/issues/articles

Price: 10 credits

Pull every article collected in an HK01 (香港01) issue (專題) dossier, section by section, newest first inside each section. Returns the same article objects as hk01/articles minus the body.

How to use it

Contents of one HK01 issue dossier. Accepts a numeric issue id or /issue/{id} URL. Articles come ordered by dossier section (see sections[] in hk01/issues), deduplicated across sections. Pass any returned id to hk01/articles for the full body.

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)
• count integer required — Max number of articles to return (min: 1)
• locale string — Content language variant (default: "zh-HK"; one of: "zh-HK", "zh-CN")

Response

• @type string (default: "Hk01ArticleCard")
• id integer required
• article_title string required
• description string nullable
• web_url string nullable
• authors array (default: [])
• zone object nullable
  • @type string (default: "Hk01ArticleZone")
  • id integer required
  • name string required
  • web_url string nullable
  • image string nullable
• main_category_id integer nullable
• main_category string nullable
• categories array (default: [])
  • @type string (default: "Hk01Category")
  • id integer required
  • name string required
  • web_url string nullable
  • image string nullable
• tags array (default: [])
  • @type string (default: "Hk01Tag")
  • id integer required
  • name string required
  • web_url string nullable
  • is_sponsored boolean (default: false)
• is_featured boolean (default: false)
• is_sponsored boolean (default: false)
• image string nullable
• original_image string nullable
• thumbnails array (default: [])
  • @type string (default: "Hk01Image")
  • image string required
  • media_id integer nullable
  • width integer nullable
  • height integer nullable
  • caption string nullable
• image_count integer nullable
• video_count integer nullable
• video object nullable
  • @type string (default: "Hk01Video")
  • id string required
  • duration integer nullable
  • source_type string nullable
  • video_type string nullable
  • width integer nullable
  • height integer nullable
  • image string nullable
• reactions array (default: [])
  • @type string (default: "Hk01Reaction")
  • name string required
  • reaction_count integer required
• published_at integer nullable
• updated_at integer 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.