/jmty/categories

POST /api/jmty/categories

Price: 10 credits

List the category tree of one Jimoty (jmty.jp) section: every category code the site uses in its URLs, its Japanese name, and the genre ids nested under it. Jimoty encodes category as a URL segment and genre as a numeric id, so this is the lookup that makes the category and genre_id filters of jmty/listings/search usable — it turns 家具 into the fur code and カーテン、ブラインド into genre 1299. For the used-car section the categories are the seventeen supported makers.

How to use it

List Jimoty categories and genres for one section. vertical is required and accepts sale, car, pet, com, coop, rec, job, les, eve, est, ser. Feed code into the category filter of jmty/listings/search and genres[].id into genre_id. Category codes are only valid inside their own section — the same code can mean different things in two sections, and a code from another section returns no listings.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• vertical string required — Section of the board to list categories for (one of: "sale", "car", "pet", "com", "coop", "rec", "job", "les", "eve", "est", "ser")

Response

• @type string (default: "JmtyCategory")
• code string required
• name string required
• url string nullable
• genres array (default: [])
  • @type string (default: "JmtyGenre")
  • id integer required
  • name string required

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 — 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.