/aljazeera/categories/articles

POST /api/aljazeera/categories/articles

Price: 5 credits

List Al Jazeera articles for a site section (news, sports, economy, opinion, videos), topic tag (football, crime) or country/region (iran, europe, us-canada). Returns listing items with title, excerpt, publish date, link, authors, featured image, video, audio version and liveblog updates, newest first.

How to use it

Browse Al Jazeera articles by category: pass a category slug or a section/tag/country page URL (URL form also resolves category_type for /tag/ and /where/ pages). The category slug must exist in the chosen category_type taxonomy: sections like 'news' or 'economy' are 'categories', topics like 'football' are 'tags', places like 'iran' or 'us-canada' are 'where'. Returns newest-first items with title, excerpt, published_at, web_url, post_type, authors, sources, image, video, audio_url and child_posts (latest liveblog updates). Use aljazeera/articles with an item's web_url to fetch the full text.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• category string required — Category slug or Al Jazeera section, tag or country page URL (examples: "news", "https://www.aljazeera.com/economy/", "https://www.aljazeera.com/tag/football/"; minLength: 1)
• category_type string — Taxonomy the category belongs to: 'categories' for site sections (news, sports, economy, opinion, videos), 'tags' for topics (football, crime), 'where' for geography (iran, europe, asia, us-canada) (default: "categories"; one of: "categories", "tags", "where")
• count integer required — Max number of articles to return (min: 1)

Response

• @type string (default: "AljazeeraCategoryArticle")
• id integer required
• replacement_title string nullable
• post_type string nullable
• excerpt string nullable
• published_at string nullable
• web_url string nullable
• short_url string nullable
• proxy_short_url string nullable
• is_breaking boolean (default: false)
• is_developing boolean (default: false)
• is_live boolean (default: false)
• authors array (default: [])
  • @type string (default: "AljazeeraAuthor")
  • id integer nullable
  • name string required
  • alias string nullable
  • description string nullable
  • job_title string nullable
  • image string nullable
  • profile_url string nullable
  • twitter_url string nullable
  • facebook_url string nullable
• sources array (default: [])
• labels array (default: [])
• image string nullable
• image_caption string nullable
• image_credit string nullable
• thumbnail string nullable
• gallery_images array (default: [])
  • @type string (default: "AljazeeraGalleryImage")
  • image string required
  • caption string nullable
  • credit string nullable
  • alt string nullable
• gallery_image_count integer nullable
• video object nullable
  • @type string (default: "AljazeeraVideo")
  • id string required
  • duration string nullable
  • url string nullable
  • aspect_ratio string nullable
• audio_url string nullable
• audio_duration number nullable
• programs array (default: [])
  • @type string (default: "AljazeeraTerm")
  • id integer nullable
  • name string required
  • alias string nullable
  • web_url string nullable
• child_posts array (default: [])
  • @type string (default: "AljazeeraChildPost")
  • id integer required
  • published_at 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 — Category, tag or place not found in the chosen category_type taxonomy 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.