# /yonhap/articles/rankings

`POST /api/yonhap/articles/rankings`

Price: 10 credits

Read a Yonhap News Agency ranking feed: editor-picked hot news, the desk's major headlines, urgent bulletins, the most viewed and longest-read stories, the most reacted-to stories, and the most viewed wire photos and videos. Every item comes back with the full wire record - headline, sub-headlines, lead, wire photos with captions, dispatch time, desk topics, keywords, byline and the reader reaction and share counters the rankings are built from.

## How to use it

Korean newsroom only. rank is the position in the feed. most_viewed and most_read_time can be narrowed to one desk with section and reach years back with date; major, breaking and most_liked accept date within roughly the last month; hot, most_viewed_photo and most_viewed_video are current-moment feeds and accept neither. Ids returned here work with yonhap/articles.

## Parameters

- `access-token` (string, required)

## Request body

- `timeout` (integer) — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
- `ranking` (string, required) — Which Yonhap ranking feed to read: editor-picked hot news, the desk's major headlines, urgent bulletins, most viewed, longest read, most reacted-to, or the most viewed wire photos and videos (one of: "hot", "major", "breaking", "most_viewed", "most_read_time", "most_liked", "most_viewed_photo", "most_viewed_video")
- `section` (string, nullable) — Desk to rank within. Accepted by the most_viewed and most_read_time feeds only; the other feeds are published newsroom-wide (one of: "main", "politics", "economy", "society", "international", "sports", "entertainment", "north_korea", "culture", "health")
- `date` (string, nullable) — Day to rank, YYYY-MM-DD. Accepted by major, breaking, most_viewed, most_read_time and most_liked; the other feeds are published for the current moment only (examples: "2026-08-04")
- `count` (integer, required) — Number of items to return (min: 1)

## Response

### 200 — Successful Response

- `@type` (string) (default: "YonhapRankedArticle")
- `rank` (integer, required)
- `id` (string, required)
- `language` (string, required)
- `article_title` (string, required)
- `subtitles` (array) (default: [])
- `description` (string, nullable)
- `web_url` (string, required)
- `image` (string, nullable)
- `images` (array) (default: [])
  - `@type` (string) (default: "YonhapArticleImage")
  - `id` (string, nullable)
  - `image` (string, required)
  - `caption` (string, nullable)
  - `image_title` (string, nullable)
  - `is_main` (boolean) (default: false)
- `published_at` (integer, nullable)
- `updated_at` (integer, nullable)
- `topics` (array) (default: [])
- `keywords` (array) (default: [])
- `writer_name` (string, nullable)
- `urgency` (integer, nullable)
- `duration` (string, nullable)
- `related_articles` (array) (default: [])
  - `@type` (string) (default: "YonhapRelatedArticle")
  - `id` (string, required)
  - `article_title` (string, nullable)
  - `web_url` (string, required)
- `reactions` (object, nullable)
  - `@type` (string) (default: "YonhapArticleReactions")
  - `like_count` (integer) (default: 0)
  - `sad_count` (integer) (default: 0)
  - `angry_count` (integer) (default: 0)
  - `follow_up_count` (integer) (default: 0)
  - `total_count` (integer) (default: 0)
- `shares` (object, nullable)
  - `@type` (string) (default: "YonhapArticleShares")
  - `kakao_talk_count` (integer) (default: 0)
  - `kakao_story_count` (integer) (default: 0)
  - `facebook_count` (integer) (default: 0)
  - `facebook_messenger_count` (integer) (default: 0)
  - `x_count` (integer) (default: 0)
  - `naver_band_count` (integer) (default: 0)
  - `naver_blog_count` (integer) (default: 0)
  - `url_count` (integer) (default: 0)
  - `native_count` (integer) (default: 0)
  - `total_count` (integer) (default: 0)

## Errors

### 422 — Validation Error

The request body did not validate

What to do: Check the fields against this schema. A URN with the wrong prefix is the most common cause.

- `detail` (array)
  - `loc` (array, required)
  - `msg` (string, required)
  - `type` (string, required)
  - `input` (any)
  - `ctx` (object)

### 408

The request ran past its time limit

What to do: 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

Ranking page carries no items

What to do: 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

What to do: 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

What to do: 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

What to do: Wait at least 30 seconds, then retry.

## Response envelope

Success: Array of objects (may be empty if no results)

Error: Error may coexist with partial results if it occurs mid-execution. Check X-Error header and status code.

Every response carries these 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.

