/rakuma/categories

POST /api/rakuma/categories

Price: 10 credits

Browse the Rakuma (fril.jp) category tree: pass a category_id to get that category with its ancestor breadcrumbs and direct children, or omit it to list all fourteen top-level categories. Every node carries its Japanese name and kana reading, the SEO name, the marketing description Rakuma shows on the category page, and the size groups that apply to it, so the ids can be fed straight into the listing search.

How to use it

Navigate Rakuma's three-level category taxonomy (1686 nodes). Omit category_id for the top-level categories, or pass one (e.g. 10006) to get that node with id, parent_category_id, name, kana_name, description, seo_name, sort, size_group_id, related_size_group_ids, is_leaf, breadcrumbs, children and url. Drill down by calling again with a child id. Feed any id, at any depth, into rakuma/items/search (category_id) or rakuma/categories/items.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• category_id integer nullable — Category id to drill into; omit to list the top-level categories (>: 0)
• count integer required — Max number of categories to return (min: 1)

Response

• @type string (default: "RakumaCategory")
• id integer required
• parent_category_id integer nullable
• name string nullable
• kana_name string nullable
• description string nullable
• seo_name string nullable
• sort integer nullable
• size_group_id integer nullable
• related_size_group_ids array (default: [])
• is_leaf boolean (default: false)
• breadcrumbs array (default: [])
• children array (default: [])
  • @type string (default: "RakumaCategoryChild")
  • id integer required
  • name string nullable
  • kana_name string nullable
  • seo_name string nullable
  • size_group_id integer nullable
  • is_leaf boolean (default: false)
  • url string nullable
• url string 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 — Category not found (well-formed but nonexistent category_id) 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.