/nhk/articles

POST /api/nhk/articles

Price: 5 credits

Get a full NHK news article by id or URL: headline, teaser, the complete body text in plain and markdown form, publish and update time, genre, region, topic tags, lead image, on-demand video with direct HLS stream links and duration, table of contents for live-updated articles and the list of related articles.

How to use it

Fetch one NHK article by its id (na-…, nb-… or nc-…) or by pasting a news.web.nhk article URL; a legacy www3.nhk.or.jp/news/html/<date>/k…….html URL and a bare k……… id also resolve. Returns one item with article_title (the short headline the site shows), document_title (the longer descriptive title, different on roughly two thirds of articles), description, text (full plain-text body), body_markdown (same body with headings and inline images), lead, published_at (the true first-publication moment, which the feeds do not carry) and updated_at (unix seconds), genres, genre_id (usable as the genre filter in nhk/articles/search), area_id (regional articles, usable as the area filter), topics with ids usable as the topic filter, playlist_id (usable in nhk/playlists), image, videos with direct HLS stream urls and duration in seconds, sections (table of contents of live-updated articles) and related_articles.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• article string required — NHK article id or the full article URL (examples: "na-k10015197981000", "https://news.web.nhk/newsweb/na/na-k10015197981000"; minLength: 1)

Response

• @type string (default: "NhkArticle")
• id string required
• article_title string required
• description string nullable
• updated_at integer nullable
• web_url string nullable
• genres array (default: [])
• genre_id string nullable
• genre_slug string nullable
• area_id string nullable
• playlist_id string nullable
• playlist_name string nullable
• topics array (default: [])
  • @type string (default: "NhkTopic")
  • id string required
  • name string required
  • is_displayed boolean (default: false)
• image string nullable
• thumbnail string nullable
• videos array (default: [])
  • @type string (default: "NhkVideo")
  • video_title string nullable
  • description string nullable
  • duration number nullable
  • embed_url string nullable
  • image string nullable
  • stream_type string nullable
  • environment_id string nullable
  • streams array (default: [])
    • @type string (default: "NhkVideoStream")
    • name string nullable
    • stream_url string required
    • formats array (default: [])
• document_title string nullable
• published_at integer nullable
• text string nullable
• lead string nullable
• lead_trimmed string nullable
• body_markdown string nullable
• lead_plain string nullable
• body_plain string nullable
• sections array (default: [])
  • @type string (default: "NhkArticleSection")
  • section_title string required
  • anchor string nullable
  • added_at integer nullable
  • is_new boolean (default: false)
• related_articles array (default: [])
  • @type string (default: "NhkRelatedArticle")
  • article_title string required
  • web_url string nullable
  • image string nullable
  • published_at integer nullable
• is_live_update boolean nullable
• is_hidden boolean nullable
• is_feature boolean nullable
• is_webview boolean nullable
• is_raw_html boolean nullable
• has_detail boolean nullable
• has_english boolean nullable
• has_twitter_card boolean nullable
• hides_new_badge boolean nullable
• is_image_geoblocked boolean nullable
• is_video_geoblocked boolean 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 — the id or URL does not resolve to an NHK article 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.