/suumo/projects/search

POST /api/suumo/projects/search

Price: 20 credits

Search SUUMO (スーモ) new-build / pre-sale condominium (新築分譲マンション) projects by prefecture, optionally scoped to a city/ward, with filters for price range, exclusive floor-area range, floor-plan layout, maximum walking distance to the nearest station, required features (e.g. pets allowed, floor heating, corner unit, performance certificate) and sort order. Returns project cards with name, marketing description, address, nearest stations, delivery time, price range (JPY), most-frequent layout/area range, number of layout types, per-phase price points and photos.

How to use it

Search SUUMO (スーモ) new-build / pre-sale condominium projects (新築分譲マンション). Provide pref (e.g. 'tokyo', 'osaka'). Optional: ward (readable slug like 'minato' or the numeric ward code '13103') to narrow within the prefecture; price_min/price_max (JPY); area_min/area_max (m2, exclusive floor area); layouts (studio/one_room/.../five_room_plus); walk_max (minutes to nearest station); facets (pets_allowed/floor_heating/corner_unit/performance_certificate/double_floor_ceiling/...); sort by newest/price_asc/price_desc/area_asc/area_desc/layout_asc/layout_desc/total_units_asc/total_units_desc. Each result has id (project path), url, name, description, address, stations (line/station/walk_min), delivery_time, price (min JPY), price_max, price_band (raw range incl. planned/価格未定), layout, area_range, layout_type_count, prices (per sales-phase price points with layout/area_range) and image/images. Use suumo/projects to fetch full details of one project; use suumo/properties/search for resale condos, houses and land.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• pref string required — Prefecture to search in (one of: "tokyo", "kanagawa", "osaka", "saitama", "chiba", "aichi", "hyogo", "fukuoka", "hokkaido", "kyoto")
• ward string nullable — City/ward to scope the search within the prefecture, as a readable slug (e.g. 'minato', 'setagaya') or the SUUMO numeric ward code (e.g. '13103') (examples: "minato", "setagaya", "13103")
• price_min integer nullable — Minimum price (JPY) (min: 0)
• price_max integer nullable — Maximum price (JPY) (min: 0)
• area_min number nullable — Minimum exclusive floor area (m2) (min: 0)
• area_max number nullable — Maximum exclusive floor area (m2) (min: 0)
• layouts array — Floor-plan layouts to include (any of) (default: []; one of: "studio", "one_room", "two_room", "three_room", "four_room", "five_room_plus")
• walk_max integer nullable — Maximum walking minutes to the nearest station (min: 1)
• facets array — Required features and conditions (all must match) (default: []; one of: "new_arrival", "has_floor_plan", "has_coverage_report", "disposer", "induction_cooker", "water_purifier", "full_parking", "pets_allowed", "enhanced_security", "front_service", "shared_facilities", "manned_24h", "garbage_24h", "earthquake_resistant", "above_20_floors", "performance_certificate", "external_insulation", "fiber_optic", "all_electric", "multiple_lines", "terminal_station", "supermarket_5min", "sea_10min", "category1_low_rise", "tokyo_tower_view", "mount_fuji_view", "double_floor_ceiling", "floor_heating", "barrier_free", "large_bathroom", "roof_balcony", "private_garden", "walk_in_closet", "large_living", "high_sash", "wide_span", "high_ceiling", "top_floor", "above_10th_floor", "corner_unit", "below_4th_floor", "south_facing")
• sort string nullable — Sort order (one of: "newest", "price_asc", "price_desc", "area_asc", "area_desc", "layout_asc", "layout_desc", "total_units_asc", "total_units_desc")
• count integer required — Max number of results to return (min: 1)

Response

• @type string (default: "SuumoProjectCard")
• id string required
• url string required
• name string nullable
• description string nullable
• address string nullable
• stations array (default: [])
  • @type string (default: "SuumoStation")
  • line string nullable
  • station string nullable
  • walk_min integer nullable
• delivery_time string nullable
• price integer nullable
• price_max integer nullable
• price_band string nullable
• layout string nullable
• area_range string nullable
• layout_type_count integer nullable
• prices array (default: [])
  • @type string (default: "SuumoProjectPrice")
  • price integer nullable
  • price_max integer nullable
  • price_text string nullable
  • sales_phase string nullable
  • layout string nullable
  • area_range 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 — 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.