/nhk/articles/playlists

POST /api/nhk/articles/playlists

Price: 1 credit

List every NHK news list (feed) that carries a given article: the genre stream, the daily stream, the regional stream and each topic or special-site stream it belongs to.

How to use it

Given an article id or URL, returns the lists it appears in, each with id, playlist_title and web_url. Feed any of those ids to nhk/articles/search via the playlist parameter to read the whole stream, or to nhk/playlists for the list metadata. An article that belongs to no list returns an empty result.

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)
• count integer required — Max number of lists to return (min: 1; max: 2000)

Response

• @type string (default: "NhkPlaylist")
• id string required
• playlist_title string required
• short_name string nullable
• description string nullable
• body_markdown string nullable
• playlist_uid string nullable
• area_id string nullable
• layout_pattern string nullable
• item_type string nullable
• list_type string nullable
• mode_of_item string nullable
• publish_level string nullable
• web_url string nullable
• image string nullable
• cover string nullable
• created_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 — 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.