/dw/programs/episodes

POST /api/dw/programs/episodes

Price: 20 credits

List the archive of one Deutsche Welle show or podcast — every episode DW still publishes — newest first, with headline, description, full transcript text, lead image and publication date.

How to use it

program accepts a program url, a path, a bare id in the form 'program-18307573', a plain number, or the exact short program name such as 'Conflict Zone' (the name field of dw/programs, which skips one lookup). Episodes are videos and audio episodes mixed — read content_type and follow up with dw/videos or dw/audios for stream urls. Chinese editions (zh, zh-hant) have no search index and are not supported here.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• program string required — DW program url, path, bare program id or exact program name (examples: "program-18307573", "Conflict Zone"; minLength: 1)
• count integer required — Number of episodes to return (min: 1; max: 10000)
• language string — DW language edition, used when the identifier carries no language segment (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")

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 — No DW program with this id or name in this language 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.