/hk01/articles

POST /api/hk01/articles

Price: 5 credits

Get a full HK01 (香港01) article by id or URL: headline, lead, structured body (text paragraphs, inline images with captions, embedded links, related-article blocks), authors, zone, channel, tags, main and original images, video metadata, social reaction counters and publish/update timestamps. Available in traditional (zh-HK) and simplified (zh-CN) Chinese.

How to use it

Fetch one HK01 article. Accepts a bare numeric id, /article/{id}, /a/{id} or the canonical /{category}/{id}/{slug} URL on www.hk01.com or global.hk01.com. Returns a single item with article_title, description, text (plain-text body), blocks (structured body), teaser, authors, zone, main_category, categories, tags, image/original_image/thumbnails, images (inline photos with captions), video, reactions, related_articles, published_at and updated_at (unix seconds). Set locale=zh-CN for the simplified-Chinese edition.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• article string required — HK01 article id or article URL (examples: "60373845", "https://www.hk01.com/article/60373845", "https://www.hk01.com/突發/60373845/青衣城持鋸漢-疑因家事公眾地方打鬥-78歲父擸鋸追兒子雙雙被捕"; minLength: 1)
• locale string — Content language variant (default: "zh-HK"; one of: "zh-HK", "zh-CN")

Response

• @type string (default: "Hk01Article")
• 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
• text string nullable
• teaser array (default: [])
• images array (default: [])
  • @type string (default: "Hk01Image")
  • image string required
  • media_id integer nullable
  • width integer nullable
  • height integer nullable
  • caption string nullable
• blocks array (default: [])
  • @type string (default: "Hk01ArticleBlock")
  • block_type string required
  • text string nullable
  • links array (default: [])
    • @type string (default: "Hk01Link")
    • text string required
    • web_url string required
  • images array (default: [])
    • @type string (default: "Hk01Image")
    • image string required
    • media_id integer nullable
    • width integer nullable
    • height integer nullable
    • caption string 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
  • questions array (default: [])
    • @type string (default: "Hk01FaqEntry")
    • question string required
    • answer string nullable
  • html string nullable
  • latitude number nullable
  • longitude number nullable
  • related_articles array (default: [])
    • @type string (default: "Hk01RelatedArticle")
    • id integer required
    • article_title string required
    • web_url string nullable
    • image string nullable
    • published_at integer nullable
• related_articles array (default: [])
  • @type string (default: "Hk01RelatedArticle")
  • id integer required
  • article_title string required
  • web_url string nullable
  • image string nullable
  • published_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 — Article not found, not yet published or no longer available 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.