/lifull/listings/search

POST /api/lifull/listings/search

Price: 10 credits

Search LIFULL HOME'S (homes.co.jp) property listings (rent or buy) by prefecture with optional filters: price range, exclusive area range, walking minutes from station, building age, structure and sort order. Returns listing cards with id, name, price, layout, area, facing, floor, address, transit and image.

How to use it

Search LIFULL HOME'S (homes.co.jp) real-estate listings. deal_type rent (賃貸) or buy (中古マンション). Required: pref (prefecture slug, e.g. 'tokyo', 'osaka'). Optional filters: price_min/price_max (rent JPY/month or sale JPY), area_min/area_max (m²), walk_minutes, built_within (years), structure (rc/wooden/steel/other); sort by recommended/price_asc/price_desc/area_desc/newest_built/newest. Each result has id, deal_type, url, name, price, layout (間取り), area (m²), facing, floor, room_number, address and transit.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• deal_type string — rent or buy (default: "rent"; one of: "rent", "buy")
• pref string required — Prefecture slug (examples: "tokyo", "osaka", "kanagawa"; minLength: 1)
• price_min integer nullable — Minimum price (rent JPY/month, buy JPY) (min: 0)
• price_max integer nullable — Maximum price (rent JPY/month, buy JPY) (min: 0)
• area_min integer nullable — Minimum exclusive area (m²) (min: 0)
• area_max integer nullable — Maximum exclusive area (m²) (min: 0)
• walk_minutes integer nullable — Max walking minutes from the nearest station (min: 1)
• built_within integer nullable — Max building age in years (min: 1)
• structure string nullable — Building structure filter (one of: "rebar", "wooden", "steelframe", "blockother")
• sort string — Sort order (default: "recommended"; one of: "recommended", "price_asc", "price_desc", "area_desc", "newest_built", "newest")
• count integer required — Max number of results to return (min: 1)

Response

• @type string (default: "LifullSearchCard")
• id string required
• deal_type string required
• url string required
• name string nullable
• price string nullable
• layout string nullable
• area number nullable
• facing string nullable
• floor string nullable
• room_number string nullable
• address string nullable
• transit array (default: [])
• image 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.