/iosys/products/rankings

POST /api/iosys/products/rankings

Price: 5 credits

Read an Iosys (イオシス) best-seller board, from the whole catalogue down to one device family such as iPhone, Google Pixel, Xperia, Galaxy, imported and domestic SIM-free phones, tablets, iPad, audio, Apple Watch, wearables, computers, Mac, laptops and gaming gear. Each entry is the listing record plus its rank position on that board.

How to use it

Read one of Iosys's best-seller boards. Pass genre to choose the board and count for how far down it to read; the board is ordered by the shop's own popularity measure, position 1 first, and boards run much deeper than the page the shop itself prints. Each entry carries position plus the listing record - id, usable with the products endpoint, name, price, stock, condition rank, warranty, accessories, the specification as text and as labelled fields, storage, release month, photographs, model family and catalogue taxonomy - plus memory_gb, display_inches, arrived_at, barcode and sticker_id. The os, cpu, optical_drive and color fields carry the shop's own search-facet code rather than the model's real value, drawn from a short closed list with 'etc' as the catch-all, so a Xiaomi phone running HyperOS reports os 'etc'; read spec for what the shop actually printed about the device. display_inches and memory_gb are blank on a large share of entries because the shop leaves those columns empty. Prices are tax-included JPY.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• genre string — Ranking board to read (default: "all"; one of: "all", "smartphone", "iphone", "android", "pixel", "xperia", "galaxy", "simfree_foreign", "simfree_domestic", "smartphone_accessories", "tablet", "ipad", "audio", "apple_watch", "wearable", "pc", "mac", "standard_laptop", "mobile_laptop", "gaming")
• count integer required — Max number of ranked listings to return (min: 1)

Response

• @type string (default: "IosysRankingProduct")
• id string required
• url string required
• name string nullable
• image string nullable
• thumbnail string nullable
• price number nullable
• currency string (default: "JPY")
• stock integer nullable
• condition string nullable
• condition_id string nullable
• warranty string nullable
• warranty_id string nullable
• accessories string nullable
• note string nullable
• spec_text string nullable
• spec object (default: {})
  • * string
• storage_gb integer nullable
• sim_size string nullable
• color string nullable
• release_date string nullable
• model_id string nullable
• model_name string nullable
• category_path string nullable
• category string nullable
• category_id string nullable
• genre string nullable
• genre_id string nullable
• genre_slug string nullable
• brand string nullable
• brand_id string nullable
• department string nullable
• department_id string nullable
• section string nullable
• section_id string nullable
• position integer (default: 0)
• memory_gb integer nullable
• display_inches number nullable
• os string nullable
• cpu string nullable
• optical_drive string nullable
• arrived_at string nullable
• barcode string nullable
• sticker_id string nullable

Errors

• 422 — Unknown genre (the board name must be one the shop publishes) 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 — The entity was not found, or a precondition failed 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.