/nhk/playlists

POST /api/nhk/playlists

Price: 1 credit

Get an NHK news list (feed) by id or URL: display name, short name, description, layout and item type, publish level, canonical web url, logo and cover images and the last update time.

How to use it

Resolve an NHK list id — the value returned as playlist_id on articles, as id by nhk/topics/search, or taken from a news.web.nhk /pl/ URL — into its title and metadata. Feed the same id to nhk/articles/search via the playlist parameter to read the articles it holds.

Parameters

• access-token string required

Request body

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

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 — List not found — the id or URL does not resolve to an NHK news list 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.