/dw/topics

POST /api/dw/topics

Price: 5 credits

Get one Deutsche Welle topic page by url or topic id: name, editorial description, background image, how many items DW filed under it and the currently featured stories.

How to use it

DW topics are the site's taxonomy — countries, organisations, people and running stories. topic accepts a full url, a path, or a bare id in the form 't-78234205'; a plain number also works. Topic ids come from an article's topics[] or from dw/topics/search, which lists the whole A-Z catalogue. For the full archive of a topic call dw/topics/articles. Base url is https://www.dw.com.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• topic string required — DW topic url, path or bare topic id (examples: "https://www.dw.com/en/ceuta-crisis/t-78234205", "t-78234205"; minLength: 1)
• 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: "DwTopic")
• id integer required
• name string required
• alias string nullable
• language string nullable
• url string nullable
• description string nullable
• teaser string nullable
• social_description string nullable
• image object nullable
  • @type string (default: "DwImage")
  • id integer nullable
  • image string nullable
  • name string nullable
  • caption string nullable
  • credit string nullable
  • image_type string nullable
• is_current boolean nullable
• is_indexed boolean nullable
• is_rtl boolean nullable
• content_count integer nullable
• featured_contents array (default: [])
  • @type string (default: "DwContentRef")
  • id integer required
  • content_type string nullable
  • headline string required
  • alias string nullable
  • url string nullable
  • language string nullable
  • subdomain string nullable
  • teaser string nullable
  • short_teaser string nullable
  • image string nullable
  • image_caption string nullable
  • content_at integer nullable
  • kicker string nullable
  • priority string nullable
  • genre string nullable
  • is_opinion boolean nullable
  • is_live_video boolean nullable
  • is_liveblog_active boolean nullable
  • duration integer nullable
  • formatted_duration string nullable
  • hls_url string nullable
  • mp3_url string nullable
  • poster_image string nullable
  • playback_format string nullable
  • image_count integer nullable
  • subtitles array (default: [])
    • @type string (default: "DwSubtitle")
    • language string nullable
    • language_code string nullable
    • subtitle_url string required
  • programs array (default: [])
    • @type string (default: "DwProgramRef")
    • id integer required
    • name string required
    • url string nullable
    • description string nullable
    • image string nullable
  • authors array (default: [])
    • @type string (default: "DwPersonRef")
    • id integer nullable
    • name string required
    • alias string nullable
    • profile_url string nullable
    • image string nullable
    • role string nullable
    • short_profile string nullable
    • twitter_handle string nullable
    • note string 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 topic with this id 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.