/suumo/listings

POST /api/suumo/listings

Price: 5 credits

Get full SUUMO (スーモ) rental listing details by jnc_{building_id}/{room_id} (or listing URL): rent, management fee, deposit and key money, layout, area, floor, facing, structure, building age, address, nearest stations with walking time, parking, transaction type, total units, handling agent and photos.

How to use it

Fetch a single SUUMO (スーモ) rental listing by composite id 'jnc_{building_id}/{room_id}' (e.g. 'jnc_000106540438/100010846228') or a full listing URL. Returns title, building_type, address, stations (line/station/walk_min), layout, layout_detail, area (m2), floor, total_floors, facing, structure, built_year_month, age, rent and management_fee (JPY), deposit, key_money, guarantee_deposit, insurance, guarantor_company, brokerage_fee, other_initial_costs, other_fees, contract_period, parking, move_in, transaction_type, conditions, total_units, property_code, shop_property_code, info_updated_at, next_update_at, remarks, agent (name/license_number) and image/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 — SUUMO rental listing as jnc_{building_id}/{room_id} or a full listing URL (examples: "jnc_000106540438/100010846228", "https://suumo.jp/chintai/jnc_000106540438/?bc=100010846228"; minLength: 1)

Response

• @type string (default: "SuumoListing")
• id string required
• building_id string required
• room_id string required
• url string required
• building_type string nullable
• address string nullable
• stations array (default: [])
  • @type string (default: "SuumoStation")
  • line string nullable
  • station string nullable
  • walk_min integer nullable
• layout string nullable
• layout_detail string nullable
• area number nullable
• floor string nullable
• total_floors string nullable
• facing string nullable
• structure string nullable
• built_year_month string nullable
• age string nullable
• rent integer nullable
• management_fee integer nullable
• deposit string nullable
• key_money string nullable
• guarantee_deposit string nullable
• insurance string nullable
• guarantor_company string nullable
• brokerage_fee string nullable
• other_initial_costs string nullable
• other_fees string nullable
• contract_period string nullable
• parking string nullable
• move_in string nullable
• transaction_type string nullable
• conditions string nullable
• total_units integer nullable
• property_code string nullable
• shop_property_code string nullable
• info_updated_at string nullable
• next_update_at string nullable
• remarks string nullable
• agent object nullable
  • @type string (default: "SuumoListingAgent")
  • name string nullable
  • license_number string nullable
• 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 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.