/kakaomap/places/rankings

POST /api/kakaomap/places/rankings

Price: 5 credits

Get the Kakao Map (카카오맵) trend ranking of places for a region and a category or menu: rank, name, category, coordinates, rating, review count, region path and the rank change

How to use it

Region takes an id such as I1000 or a name path such as 서울 강남구; category takes codes like category_korean or menu_pizza. Ranked place ids work in kakaomap/places.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• region string nullable — Region id (a province I, a district I1000 or a neighbourhood I10000400) or its Korean name path, province first. Empty means the whole country (examples: "I1000", "서울 강남구", "서울 강남구 삼성동")
• category string nullable — Category or menu code such as category_korean, category_cafe or menu_pizza. Empty means all categories (examples: "category_korean", "menu_pizza"; pattern: ^(?:category|menu)_[a-z0-9_]+$)
• metric string — Signal the ranking is built on: share, search, path or favorite (default: "share"; one of: "share", "search", "path", "favorite")
• count integer required — Max number of places to return (min: 1; max: 100)

Response

• @type string (default: "KakaomapRankedPlace")
• rank integer required
• id string required
• url string required
• name string nullable
• category string nullable
• latitude number nullable
• longitude number nullable
• image string nullable
• rating number nullable
• review_count integer nullable
• regions array (default: [])
• region_ids array (default: [])
• is_owner_registered boolean nullable
• services array (default: [])
• rank_change integer nullable
• is_hot boolean nullable
• click_count_increase_rate integer nullable
• destination_count_increase_rate integer nullable
• ranked_at integer nullable

Errors

• 422 — Unknown category code 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 — Kakao Map has no ranking region under that id or name 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.