/spiegel/articles/search

POST /api/spiegel/articles/search

Price: 10 credits

Search Der Spiegel and the other Spiegel-Group mastheads by keyword, by byline or by both, optionally restricted to a publication date range and to a subset of mastheads. Returns listing entries with headline, kicker, standfirst, publication time, authors, section, a subscriber-only flag and live and breaking-news flags, newest first.

How to use it

The workhorse discovery endpoint for Spiegel, ordered newest first. Pass keyword, author, or both — author matches the byline and combines with keyword as AND. scope=headline_and_lead narrows the keyword match to heading, title and intro instead of the whole text. published_after and published_before are unix seconds and reach back to 1900. brands defaults to the three Spiegel mastheads (spon, spon_paid, spon_international); adding mmo, hbm, elf or effi widens the search to manager-magazin, Harvard Business manager, 11FREUNDE and Effilee, whose web_url points at their own domains and will not open through spiegel/articles — is_spiegel marks the ones that will. Each entry carries id (the uuid), article_title, heading, description, web_url, published_at, authors, channel, is_premium, is_live and is_breaking; feed id into spiegel/articles for the body. Spiegel serves at most 10000 results for one query however large count is; narrow the date range to reach further back.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string — Search phrase; leave empty when searching by author instead (default: ""; examples: "Ebola", "künstliche Intelligenz")
• author string — Byline to search for; combine with keyword to require both (default: ""; examples: "Fritz Schaap")
• count integer required — Max number of results to return (min: 1; max: 10000)
• scope string — Match the keyword against the whole article text, or only headline and lead (default: "full_text"; one of: "full_text", "headline_and_lead")
• brands array — Spiegel-Group mastheads to search; the index is shared, and the non-Spiegel mastheads return articles on their own domains (default: ["spon","spon_paid","spon_international"]; one of: "spon", "spon_paid", "spon_international", "mmo", "mmo_paid", "hbm", "hbm_paid", "elf", "elf_paid", "effi", "effi_paid")
• published_after integer nullable — Only articles published at or after this unix timestamp; Spiegel's index starts at -2208988800
• published_before integer nullable — Only articles published at or before this unix timestamp

Response

• @type string (default: "SpiegelSearchResult")
• id string required
• article_title string required
• heading string nullable
• description string nullable
• web_url string required
• published_at integer nullable
• access_level string nullable
• is_premium boolean (default: false)
• brand string nullable
• is_spiegel boolean (default: false)
• collection string nullable
• content_type string nullable
• style string nullable
• is_breaking boolean (default: false)
• is_live boolean (default: false)
• section string nullable
• channel object nullable
  • @type string (default: "SpiegelChannel")
  • id string nullable
  • name string required
  • alias string nullable
  • sub_channel_id string nullable
  • sub_channel_name string nullable
  • sub_channel_alias string nullable
• byline_prefix string nullable
• byline_suffix string nullable
• authors array (default: [])
  • @type string (default: "SpiegelAuthor")
  • name string required
  • image_id string nullable
• image_id string nullable
• teaser_length integer nullable
• teaser_style string nullable

Errors

• 422 — Neither keyword nor author given, empty brands, count out of range, or published_after later than published_before 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.