/yomiuri/articles/search

POST /api/yomiuri/articles/search

Price: 10 credits

Search The Japan News by keyword, with filters for the publication window, the result ordering and whether the keyword has to appear in the headline or anywhere in the story. Returns headline, url, teaser, publish date, section label and thumbnail.

How to use it

Search The Japan News (English edition of The Yomiuri Shimbun). Set search_in to headline_and_body for a much wider match than the default headline-only search. date_range narrows to the last day, week or month; sort switches between newest, oldest and most popular. Every item carries an id that yomiuri/articles accepts and tag names that yomiuri/tags/articles accepts. A keyword nobody wrote about returns an empty list.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string required — Search keyword (examples: "nuclear", "typhoon"; minLength: 1; maxLength: 200)
• count integer required — Max number of results (min: 1)
• date_range string — Restrict results to a recent time window (default: "any_time"; one of: "any_time", "past_24_hours", "past_7_days", "past_30_days")
• sort string — Result ordering (default: "newest"; one of: "newest", "oldest", "popular")
• search_in string — Match the keyword against headlines only, or headlines and body text (default: "headline"; one of: "headline", "headline_and_body")

Response

• @type string (default: "YomiuriArticleCard")
• id string required
• article_title string required
• web_url string nullable
• excerpt string nullable
• published_at integer nullable
• section string nullable
• image string nullable
• tags array (default: [])

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.