/kyodo/articles/search

POST /api/kyodo/articles/search

Price: 5 credits

Search Kyodo News for a phrase and get matching articles newest first, with headline, publish time, the wire or partner that supplied the story and its url. The search index reaches back to the start of the edition, so old stories are findable even though their body text is no longer served. X-Total-Available-Results carries the total number of matches the site reports.

How to use it

Full-text search over one Kyodo News edition. phrase is matched against headline and body, so a topic word ('Hiroshima') or a phrase both work; there are no date, category or sort filters — the order is always newest first. Set edition to pick the language (en, zh-cn, zh-tw); each edition has its own index. Results carry no body text — pass id or web_url to kyodo/articles for the story itself, and read its body_access to see how much of the text the site still serves.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• phrase string required — Free-text query matched against article headlines and body copy (examples: "Hiroshima", "semiconductor exports"; minLength: 1)
• edition string — Language edition to search (default: "en"; one of: "en", "zh-cn", "zh-tw")
• count integer required — Max number of articles to return (min: 1)

Response

• @type string (default: "KyodoArticleCard")
• id string required
• edition string required
• article_title string required
• web_url string required
• published_at integer nullable
• source string nullable
• source_id string nullable
• source_url string nullable
• image string 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 — 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.