/nytimes/collections/articles

POST /api/nytimes/collections/articles

Price: 10 credits

List what a New York Times section front, topic hub, column or series has published — articles, videos, interactives, slideshows, audio and recipes. The editors' currently highlighted picks come first, then everything else newest first. Each item carries headline, summary, kicker, authors, section, topic tags, lead image and publication times.

How to use it

Page through a nytimes.com section front ('section/world'), a subsection ('section/world/europe'), a topic hub ('topic/destination/ukraine'), a column or a series. collection takes the full URL or the bare path. A section front that runs an editors' highlights rail serves those 4-14 items first — they are not in the chronological stream at all — and everything after them is newest first. Each item carries uri (feed it to nytimes/articles for articles, nytimes/recipes for recipes), web_url, document_title, summary, authors, section and image; asset_type says which kind of item it is, and related is filled on video rows and on older articles. At most 1100 items are reachable per collection however many it reports.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• collection string required — New York Times section front, topic hub, column or series URL or path (examples: "https://www.nytimes.com/section/world", "section/business/dealbook", "topic/destination/ukraine"; minLength: 1)
• count integer required — Max number of items to return (min: 1; max: 1100)

Response

• @type string (default: "NytimesAsset")
• uri string required
• asset_type string required
• document_type string nullable
• web_url string nullable
• alias string nullable
• document_title string required
• seo_title string nullable
• sub_headline string nullable
• kicker string nullable
• summary string nullable
• promotional_headline string nullable
• promotional_summary string nullable
• published_at integer nullable
• updated_at integer nullable
• word_count integer nullable
• tone string nullable
• desk string nullable
• language string nullable
• section object nullable
  • @type string (default: "NytimesSectionRef")
  • uri string nullable
  • name string required
  • display_name string nullable
  • web_url string nullable
• subsection object nullable
  • @type string (default: "NytimesSectionRef")
  • uri string nullable
  • name string required
  • display_name string nullable
  • web_url string nullable
• authors array (default: [])
  • @type string (default: "NytimesPersonRef")
  • uri string nullable
  • name string required
  • alias string nullable
  • job_title string nullable
  • web_url string nullable
• byline string nullable
• image object nullable
  • @type string (default: "NytimesImage")
  • uri string nullable
  • image string required
  • width integer nullable
  • height integer nullable
  • caption string nullable
  • credit string nullable
  • alt_text string nullable
• tags array (default: [])
  • @type string (default: "NytimesTag")
  • uri string nullable
  • name string required
  • tag_type string nullable
• related array (default: [])
  • @type string (default: "NytimesArticleReference")
  • uri string required
  • asset_type string nullable
  • document_title string nullable
  • web_url string nullable
• duration_seconds integer 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 — No New York Times collection at this path, or it points at an article or author page 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.