/lifull/listings

POST /api/lifull/listings

Price: 10 credits

Get full LIFULL HOME'S (homes.co.jp) property listing details by URL or id (rent room or buy building): name, price, management/maintenance fees, deposit/key money, layout, area, balcony area, facing, floor, total floors and units, built date, address, transit (line/station/walk), structure, parking, status, contract terms, renewal fee, guarantor company, transaction type, real-estate company, listing number, location path and images.

How to use it

Fetch a single LIFULL HOME'S (homes.co.jp) real-estate listing by full URL, a rent room hash ('/chintai/room/{hash}/'), or a buy building id ('/mansion/b-{id}/', also kodate/tochi). deal_type (rent/buy) is auto-detected from the input. Returns name, price (rent 賃料 or sale 価格), management_fee/maintenance_fee, deposit/key_money, layout (間取り), area (専有面積 in m²), balcony_area, facing (主要採光面), floor/total_floors, total_units, built (築年月), address, transit (list of line/station/walk_minutes), structure (建物構造), parking, status (現況), contract_period, renewal_fee, guarantor_company, transaction_type (取引態様), company_name (real-estate company), listing_number, location_path and images.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• listing string required — LIFULL HOME'S listing as a full URL, a rent room hash, or a buy building id. Rent: /chintai/room/{hash}/ ; Buy: /mansion/b-{id}/ (also kodate/tochi). (examples: "https://www.homes.co.jp/chintai/room/587276d55afb63e90334bcc6f46c2e821b3d191f/", "https://www.homes.co.jp/mansion/b-1090830005055/", "587276d55afb63e90334bcc6f46c2e821b3d191f"; minLength: 1)

Response

• @type string (default: "LifullListing")
• id string required
• deal_type string required
• url string required
• name string nullable
• price string nullable
• management_fee string nullable
• maintenance_fee string nullable
• deposit string nullable
• key_money string nullable
• layout string nullable
• area number nullable
• balcony_area number nullable
• facing string nullable
• floor string nullable
• total_floors string nullable
• total_units string nullable
• built string nullable
• address string nullable
• transit array (default: [])
  • @type string (default: "LifullTransit")
  • line string nullable
  • station string nullable
  • walk_minutes integer nullable
  • raw string nullable
• structure string nullable
• parking string nullable
• status string nullable
• available_from string nullable
• contract_type string nullable
• contract_period string nullable
• renewal_fee string nullable
• other_fees string nullable
• guarantor_company string nullable
• land_rights string nullable
• use_district string nullable
• management string nullable
• transaction_type string nullable
• pets string nullable
• other_conditions string nullable
• remarks string nullable
• housing_insurance string nullable
• handover string nullable
• land_law_notification string nullable
• published_at string nullable
• updated_at string nullable
• company_name string nullable
• listing_number string nullable
• location_path array (default: [])
• image string nullable
• images array (default: [])

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 — Listing not found (well-formed id/URL but the listing page does not exist) 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.