/rakuma/brands

POST /api/rakuma/brands

Price: 20 credits

List the brands Rakuma (fril.jp) recognises — 18,694 of them, each with its id, display name, Japanese kana reading and brand page URL. Narrow the list by a substring of the name or kana reading, or ask for a single brand by id. The ids are what the listing search and the brand listing endpoint expect.

How to use it

Resolve Rakuma brand ids. query matches a substring of either the Latin/display name or the katakana reading, case-insensitively, so both 'louis' and 'ルイ' work. brand_id returns just that brand. Each entry has id, name, kana_name and url. Feed id into rakuma/items/search (brand_id) or rakuma/brands/items.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• query string — Keep only brands whose name or kana reading contains this text (default: ""; examples: "louis", "ナイキ")
• brand_id integer nullable — Return only the brand with this id (>: 0)
• count integer required — Max number of brands to return (min: 1)

Response

• @type string (default: "RakumaBrand")
• id integer required
• name string nullable
• kana_name 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 — Brand not found (well-formed but nonexistent brand_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.