/joshin/products/ranking

POST /api/joshin/products/ranking

Price: 20 credits

Get the popularity ranking of one Joshin (上新電機) category: the best selling products in rank order, each with JAN code, URL, name, manufacturer, model code, image, tax-included price, Joshin point reward, stock and shipping state, release date and short description.

How to use it

Fetch the best sellers of one joshin (joshinweb.jp) category. Pass genre plus category (the numeric category id, or a full category URL, both published by the categories endpoint). Each item carries rank plus id (13-digit JAN), url, genre, category_id, name, maker, model_code, image, price, point/point_rate, stock_message, is_in_stock, delivery_message, release_date, description, review_group and is_sponsored. Joshin publishes a ranking for a part of its categories only.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• genre string required — Genre the category belongs to (one of: "kaden", "season", "house", "kitchen", "health", "interior", "av", "sound", "audio", "pc", "peripheral", "supply", "mobile", "camera", "car", "diy", "outdoor", "apparel", "watch", "game", "toy", "hobby", "train", "cg", "liquor", "drug"; examples: "game")
• category string required — Category id inside the genre, or a full category URL (examples: "73607", "https://joshinweb.jp/game/73607.html"; minLength: 1)
• count integer required — Max number of ranked products to return (min: 1)

Response

• @type string (default: "JoshinRankingItem")
• id string required
• url string required
• genre string required
• category_id string required
• name string nullable
• maker string nullable
• model_code string nullable
• image string nullable
• price number nullable
• currency string (default: "JPY")
• point integer nullable
• point_rate number nullable
• stock_message string nullable
• is_in_stock boolean nullable
• delivery_message string nullable
• release_date string nullable
• description string nullable
• review_group string nullable
• is_sponsored boolean (default: false)
• rank 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 — This category has no ranking page, or the genre and category id do not name a Joshin category 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.