/kyodo/categories/search

POST /api/kyodo/categories/search

Price: 1 credit

List every browsable category of a Kyodo News edition: the editorial desks it files stories under (news/japan, news/sports, news/expo) and the wires and partners it republishes (partners/kyodo_news, partners/apnews, partners/reuters). The three editions keep different catalogues. The list is read live from the site, so categories that never appear in the top navigation are included too.

How to use it

Discover what can be browsed before calling kyodo/categories/articles: every id returned here ('news/japan', 'partners/reuters') is accepted there as-is. kind separates editorial desks ('news') from syndication partners ('partners'). The navigation menu of the site shows only a handful of these, so do not guess slugs — list them. Each edition (en, zh-cn, zh-tw) has its own set, and ids are not shared between editions.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• edition string — Language edition whose catalogue to list (default: "en"; one of: "en", "zh-cn", "zh-tw")
• count integer required — Max number of categories to return (min: 1)

Response

• @type string (default: "KyodoCategory")
• id string required
• edition string required
• alias string required
• kind string required
• web_url string required

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 — The entity was not found, or a precondition failed 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.