/yodobashi/products/ranking

POST /api/yodobashi/products/ranking

Price: 10 credits

Top 20 best selling Yodobashi Camera (ヨドバシカメラ) products of a category (人気ランキング): rank, days spent inside the category top 100, plus the usual product card fields.

How to use it

Best sellers of a yodobashi.com category. Pass a category path of at least two levels (e.g. '19531/19534' from the categories endpoint); top-level categories have no ranking page. Each item has rank, days_in_top_100, id (SKU), url, name, brand, image, price, point/point_rate, stock_message, delivery_message, maker+maker_id, release_date, rating, review_count and store_stock_count.

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 path with at least two levels, e.g. '19531/19534' (examples: "19531/19534", "157851/239001/244005/244006"; minLength: 1)
• count integer required — Max number of results to return (min: 1; max: 20)

Response

• @type string (default: "YodobashiRankingItem")
• id string required
• url string required
• name string nullable
• brand string nullable
• image string nullable
• price number nullable
• currency string (default: "JPY")
• point integer nullable
• point_rate number nullable
• stock_message string nullable
• delivery_message string nullable
• maker string nullable
• maker_id string nullable
• category string nullable
• category_id string nullable
• release_date string nullable
• rating number nullable
• review_count integer nullable
• store_stock_count integer nullable
• rank integer nullable
• days_in_top_100 integer 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 ranking page for this category (unknown path, or a top-level category that has no ranking) 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.