/kyodo/articles

POST /api/kyodo/articles

Price: 1 credit

Get one Kyodo News article by id or url: headline, meta description, body text, publish and last-modified timestamps, writer byline, the wire or partner that supplied it, the categories it is filed under, every header photo with its caption, embedded podcast and video players, and the related-coverage links. Available in the English, simplified Chinese and traditional Chinese editions, each of which numbers its articles separately. Kyodo's own copy carries the full body only for the first days after publication — body_access and is_body_truncated say which part of the text the response holds.

How to use it

Fetch a single Kyodo News story. article takes the numeric id ('81610') or the article url; a url also decides the edition, otherwise set edition (en, zh-cn, zh-tw — the three editions publish different stories and reuse the same id numbers, so an id from one edition means a different story or nothing at all in another). body_access tells you how much text you got: 'open' is the complete story, 'membership' is the lead plus one teaser paragraph, 'archived' means the piece is older than about three months and only the opening line is served. Headline, timestamps, photos, categories and related links are complete in all three states. Feed categories[].id into kyodo/categories/articles, and related[].id back into this endpoint.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• article string required — Kyodo article id or its full url (examples: "81610", "https://english.kyodonews.net/articles/-/81610"; minLength: 1)
• edition string — Language edition to read the article from; ignored when article is a full url (default: "en"; one of: "en", "zh-cn", "zh-tw")

Response

• @type string (default: "KyodoArticle")
• id string required
• edition string required
• article_title string required
• description string nullable
• text string nullable
• web_url string required
• language string nullable
• published_at integer nullable
• updated_at integer nullable
• author string nullable
• source string nullable
• source_id string nullable
• source_url string nullable
• source_image string nullable
• categories array (default: [])
  • @type string (default: "KyodoArticleCategory")
  • id string required
  • name string required
  • web_url string required
• image string nullable
• image_width integer nullable
• image_height integer nullable
• images array (default: [])
  • @type string (default: "KyodoArticleImage")
  • image string required
  • caption string nullable
• embed_urls array (default: [])
• related array (default: [])
  • @type string (default: "KyodoRelatedArticle")
  • id string required
  • article_title string required
  • web_url string required
• body_access string required
• is_body_truncated boolean required
• is_accessible_for_free boolean nullable
• paragraph_count integer 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 — No article with this id in the requested edition 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.