/suumo/projects

POST /api/suumo/projects

Price: 10 credits

Get full SUUMO (スーモ) new-build / pre-sale condominium (新築分譲マンション) project details by project path (or project URL): project name, price range (JPY), most-frequent price band, address, nearest stations, layouts, exclusive-area range, total units, units currently for sale, structure, site area, building area, total floor area, use district, land rights, completion and delivery dates, management and repair-reserve fees, parking, sales schedule, provider companies, inquiry contact, representative floor-plan types (layout, area, price, sales phase) and photos.

How to use it

Fetch a single SUUMO (スーモ) new-build / pre-sale condominium project (新築分譲マンション) by path (e.g. 'ms/shinchiku/tokyo/sc_minato/nc_67731397') or a full project URL. Returns name, price (min JPY), price_max, price_text (raw range incl. planned/未定), price_band (most-frequent band), address, stations (line/station/walk_min), layout, area_range, other_area, total_units, units_for_sale, structure, site_area, building_area, total_floor_area, use_district, land_rights, completion_date, delivery_time, management_fee, management_preparation_fee, repair_reserve_fund, repair_reserve_basic_fund, other_fees, parking, bicycle_parking, motorcycle_parking, management_form, property_kind, sales_schedule, restrictions, other_overview, terms_expire_at, sellers (provider companies), inquiry_name, inquiry_phone, floor_plans (type/layout/area/price/sales_phase per representative unit) and image/images. This is the rich project-level view for pre-sale condos; use suumo/properties for used/new houses, land and resale condos.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• project string required — SUUMO new-build condominium project path (e.g. ms/shinchiku/tokyo/sc_minato/nc_67731397) or a full project URL (examples: "ms/shinchiku/tokyo/sc_minato/nc_67731397", "https://suumo.jp/ms/shinchiku/tokyo/sc_minato/nc_67731397/"; minLength: 1)

Response

• @type string (default: "SuumoProject")
• id string required
• url string required
• name string nullable
• price integer nullable
• price_max integer nullable
• price_text string nullable
• price_band 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
• area_range string nullable
• other_area string nullable
• total_units integer nullable
• total_units_text string nullable
• units_for_sale integer nullable
• units_for_sale_text string nullable
• structure string nullable
• site_area number nullable
• building_area number nullable
• total_floor_area number nullable
• use_district string nullable
• land_rights string nullable
• completion_date string nullable
• delivery_time string nullable
• management_fee string nullable
• management_preparation_fee string nullable
• repair_reserve_fund string nullable
• repair_reserve_basic_fund string nullable
• other_fees string nullable
• parking string nullable
• bicycle_parking string nullable
• motorcycle_parking string nullable
• management_form string nullable
• property_kind string nullable
• sales_schedule string nullable
• restrictions string nullable
• other_overview string nullable
• terms_expire_at string nullable
• sellers array (default: [])
• inquiry_name string nullable
• inquiry_phone string nullable
• floor_plans array (default: [])
  • @type string (default: "SuumoProjectFloorPlan")
  • type string nullable
  • layout string nullable
  • area number nullable
  • price integer nullable
  • price_text string nullable
  • sales_phase string nullable
  • url string nullable
  • image 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 — Project not found (well-formed path but the project 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.