/rfi/sections/articles

POST /api/rfi/sections/articles

Price: 1 credit

List the stories RFI publishes on any of its listing pages, newest first: a news section, the rolling live-news feed, an author page or a monthly archive. Each entry carries headline, section, editorial genre label, thumbnail, whether the story is a video and, on the listings that print one, the publication time; it goes as deep into the listing as the requested count needs.

How to use it

Browse RFI by page. section takes any listing path with the language segment first — a news section, the rolling wire feed, an author page or a monthly archive — and a full page URL works too, with any page number in it ignored, so the answer always starts at the newest. Each edition names its sections in its own language, and a section RFI has renamed is followed to the front it serves today, so 'en/sports' answers with 'en/sport'. How deep a surface goes varies sharply: a section front and the wire feed are a single page of a few dozen stories, while an author page or a monthly archive paginates for thousands, and the walk stops after 400 pages rather than erroring. A section front prints a publication time on most of its cards, the one exception measured being fr/afrique, which prints none at all; a monthly archive gives the day heading in published_label with no machine date. For a subject use rfi/tags/articles, for a programme's episodes rfi/podcasts/episodes, the only listing that returns the MP3 itself; feed web_url into rfi/articles for the body and the audio.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• section string required — RFI listing page path, or the URL of that page (examples: "en/africa", "en/live-news", "https://www.rfi.fr/fr/afrique/", "en/archives/2020/06", "en/author/rfi"; minLength: 1)
• count integer required — Max number of articles to return (min: 1)

Response

• @type string (default: "RfiArticleCard")
• article_title string required
• web_url string required
• alias string required
• published_at integer nullable
• published_label string nullable
• language string required
• section string nullable
• label string nullable
• image string nullable
• is_audio boolean (default: false)
• is_video boolean (default: false)

Errors

• 422 — Not an RFI listing path 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 RFI listing page at this path 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.