/rakuma/items/search

POST /api/rakuma/items/search

Price: 20 credits

Search Rakuma (fril.jp) listings with the marketplace's full filter set: keyword and excluded keyword, brand, category at any depth, clothing or shoe size, price range, item condition, on-sale or sold-out, authenticity-check coverage, official shop programmes (outlet, overseas import, food and household), minimum Rakuten point-back rate, anonymous shipping, seller-paid postage, and ordering by relevance, newest, likes or price. Sold-out listings keep their final price, which makes this a source of Japanese resale comparables. Each result carries id, name, price, sold flag, brand, category, seller id and image.

How to use it

Search Rakuma, Rakuten's Japanese C2C marketplace. All filters are optional except count. brand_id comes from rakuma/brands, category_id from rakuma/categories, size_id from rakuma/sizes. conditions accepts new / almost_unused / no_visible_damage / slight_damage / damaged / poor. transaction picks all, on_sale or sold_out — use sold_out for completed-sale prices. business_types accepts official_shops, exclude_official_shops, reuse_official, overseas_import, outlet, food_and_household. sort accepts relevance, created_at, like_count or price together with order asc/desc. Results carry id (32-hex, feed it to rakuma/items), internal_id, name, price, currency, is_sold, brand, category, category_path, seller_id, seller_type, image and url. On this surface rakuma publishes the category id without its name, so category.name is null and category_path is empty — resolve the names through rakuma/categories. Keyword matching is fuzzy: a keyword with no real matches still returns loosely related listings rather than an empty list.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• query string — Keyword to search listings for (default: ""; examples: "ルイヴィトン", "iphone")
• excluded_query string — Keyword that must not appear in the listing (default: "")
• brand_id integer nullable — Only listings of this brand, taken from rakuma/brands (>: 0)
• exclude_no_brand boolean — Drop listings that have no brand assigned (default: false)
• category_id integer nullable — Only listings in this category, at any depth, taken from rakuma/categories (>: 0)
• size_id integer nullable — Only listings in this clothing or shoe size, taken from rakuma/sizes (>: 0)
• min_price integer nullable — Lowest price in JPY (min: 0)
• max_price integer nullable — Highest price in JPY (min: 0)
• conditions array — Item conditions to include (default: []; one of: "new", "almost_unused", "no_visible_damage", "slight_damage", "damaged", "poor")
• transaction string — Whether to include listings still on sale, sold ones or both (default: "all"; one of: "all", "on_sale", "sold_out")
• authenticity array — Only listings covered by Rakuma's authenticity check (default: []; one of: "before_delivery", "after_delivery")
• business_types array — Restrict to official shop programmes such as outlet or import (default: []; one of: "official_shops", "exclude_official_shops", "reuse_official", "overseas_import", "outlet", "food_and_household")
• min_redeem_rate string nullable — Only listings with at least this Rakuten point-back rate (one of: "any_rate", "at_least_3", "at_least_5", "at_least_7", "at_least_10", "at_least_15", "at_least_20")
• anonymous_shipping boolean — Only listings shipped anonymously (default: false)
• postage_included boolean — Only listings where the seller pays shipping (default: false)
• sort string — Field the results are ordered by (default: "relevance"; one of: "relevance", "created_at", "like_count", "price")
• order string — Direction of the ordering (default: "desc"; one of: "asc", "desc")
• count integer required — Max number of listings to return (min: 1; max: 4000)

Response

• @type string (default: "RakumaItemCard")
• id string required
• internal_id integer nullable
• name string required
• price number nullable
• currency string (default: "JPY")
• is_sold boolean (default: false)
• brand object nullable
  • @type string (default: "RakumaBrandRef")
  • id integer required
  • name string nullable
  • url string nullable
• category object nullable
  • @type string (default: "RakumaCategoryRef")
  • id integer nullable
  • name string nullable
  • url string nullable
• category_path array (default: [])
  • @type string (default: "RakumaCategoryRef")
  • id integer nullable
  • name string nullable
  • url string nullable
• seller_id integer nullable
• seller_type string nullable
• image 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 — 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.