/dw/articles/search

POST /api/dw/articles/search

Price: 20 credits

Search Deutsche Welle content in any of its 29 searchable language editions: articles, live blogs, videos, audio episodes and image galleries with headline, teaser, full body text, lead image, publication date, category, region and program. Supports free text, content type, genre, priority, category, kicker, region, subject, program and publication date filters.

How to use it

The workhorse discovery endpoint for DW. Leave keyword empty to browse the newest content of an edition. Every result carries url and id — feed them to dw/articles (ARTICLE, LIVEBLOG and LIVEBLOG_ELEMENT, the individual posts of a live blog), dw/videos, dw/audios, dw/galleries, dw/topics (AUTO_TOPIC), dw/authors (PERSON), dw/programs (PROGRAM and SERIES) or dw/sections (NAVIGATION) depending on content_type. Filters are multi-select and combine with AND across fields, OR inside one field; category, kicker, region, subject and program take the values DW uses in that edition's own language, and dw/facets lists them all with counts. Chinese (zh, zh-hant) has no search index at DW — use dw/sections or dw/topics/articles there instead.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string — Full text query; leave empty to browse the newest content of the edition (default: "")
• language string — DW language edition to search in (default: "en"; one of: "de", "en", "ar", "es", "ru", "fr", "uk", "tr", "fa-ir", "fa-af", "ps", "ur", "hi", "bn", "pt-br", "pt-002", "pl", "ro", "sr", "bs", "hr", "mk", "sq", "bg", "el", "zh", "zh-hant", "id", "sw", "ha", "am")
• count integer required — Number of results to return (min: 1; max: 10000)
• media_type array nullable — Keep only these content types (one of: "ARTICLE", "LIVEBLOG", "LIVEBLOG_ELEMENT", "VIDEO", "AUDIO", "IMAGE_GALLERY", "PERSON", "AUTO_TOPIC", "PROGRAM", "NAVIGATION", "SERIES")
• genre array nullable — Keep only these editorial genres (one of: "NONE", "NEWS", "COMMENT", "DOSSIER", "INTERVIEW", "COLUMN")
• priority array nullable — Keep only content with these editorial priorities (one of: "NEUTRAL", "HIGH", "EXCLUSIVE", "BREAKING_NEWS")
• subdomain array nullable — Keep only content published on these DW surfaces (one of: "NEWS", "STREAMING", "UNKNOWN")
• category array nullable — Keep only these categories, named in the language of the edition (examples: ["Politics","Business"])
• kicker array nullable — Keep only these teaser kickers, named in the language of the edition
• region array nullable — Keep only these countries or world regions, named in the language of the edition (examples: ["Ukraine"])
• subject array nullable — Keep only these editorial subjects, named in the language of the edition
• program array nullable — Keep only content belonging to these DW programs (examples: ["Conflict Zone"])
• published_from string nullable — Keep only content published at or after this date (examples: "2020-01-01")
• published_to string nullable — Keep only content published at or before this date (examples: "2020-12-31")
• sort string — Result ordering (default: "newest"; one of: "newest", "oldest", "relevance")

Response

• @type string (default: "DwSearchResult")
• id integer required
• content_type string nullable
• language string nullable
• headline string required
• url string nullable
• teaser string nullable
• short_teaser string nullable
• text string nullable
• image string nullable
• image_caption string nullable
• content_at integer nullable
• kicker string nullable
• priority string nullable
• genre string nullable
• subdomain string nullable
• categories array (default: [])
• regions array (default: [])
• subjects array (default: [])
• programs array (default: [])
  • @type string (default: "DwSearchProgramRef")
  • id integer nullable
  • name string required
• duration integer nullable
• formatted_duration string nullable
• poster_image string nullable
• playback_format string nullable
• image_count integer nullable
• image_captions array (default: [])
• is_live_video boolean nullable
• is_liveblog_active boolean nullable
• is_auto_delivery boolean 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 — This DW language edition has no search index 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.