# /suumo/properties/search

`POST /api/suumo/properties/search`

Price: 5 credits

Search SUUMO (スーモ) for-sale properties by prefecture and category (used condominium, used/new house, land), optionally scoped to a city/ward or to a railway line and specific stations, with filters for price range, floor/building/land area range, floor-plan layout, maximum building age, maximum walking distance to the nearest station, per-category amenities (e.g. pets allowed, elevator, south-facing, city gas, flat ground) and sort order. Returns property cards with name, price, address, transport, area, building area, land area, layout, balcony area, build year-month and image.

## How to use it

Search SUUMO (スーモ) for-sale properties. Provide pref (e.g. 'tokyo', 'osaka'); choose property_type (used_mansion/used_house/new_house/land). Narrow the location either by ward (city/ward code) or by line (railway line name, e.g. 'JR山手線') plus stations (station names along that line, e.g. ['新宿','渋谷'] — requires line). Other filters: price_min/price_max (JPY); area_min/area_max (m2, condominiums); building_area_min/max and land_area_min/max (m2, houses/land); layouts (studio/one_room/.../five_room_plus); max_age (years); walk_max (minutes to nearest station); sort by newest/price_asc/price_desc/area_asc/area_desc/built_oldest/built_newest. Per-category amenities: condo_facets (pets_allowed/parking_available/south_facing/elevator/roof_balcony) for used_mansion; house_facets (parking_two_cars/has_movie/city_gas/ldk_15_tatami_plus/south_facing) for used/new_house; land_facets (hilltop/regular_shape/flat_ground/city_gas/public_sewer) and build_condition (with/without) for land. Each result has id (property path), url, name, headline, price (JPY), address, transport, area (m2), building_area, land_area, layout, balcony_area, built_year_month and image.

## 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")
- `line` (string, nullable) — Railway line name to search along (e.g. 'JR山手線', '東京メトロ銀座線') (minLength: 1)
- `stations` (array) — Station names to search near (e.g. '新宿', '渋谷'); requires line to be set (default: [])
- `property_type` (string) — Property category to search (default: "used_mansion"; one of: "used_mansion", "used_house", "new_house", "land")
- `price_min` (integer, nullable) — Minimum sale price (JPY) (min: 0)
- `price_max` (integer, nullable) — Maximum sale price (JPY) (min: 0)
- `area_min` (number, nullable) — Minimum exclusive floor area (m2), for condominiums (min: 0)
- `area_max` (number, nullable) — Maximum exclusive floor area (m2), for condominiums (min: 0)
- `building_area_min` (number, nullable) — Minimum building area (m2), for houses (min: 0)
- `building_area_max` (number, nullable) — Maximum building area (m2), for houses (min: 0)
- `land_area_min` (number, nullable) — Minimum land area (m2), for houses and land (min: 0)
- `land_area_max` (number, nullable) — Maximum land area (m2), for houses and land (min: 0)
- `layouts` (array, nullable) — Floor-plan layouts to include (any of) (one of: "studio", "one_room", "two_room", "three_room", "four_room", "five_room_plus")
- `max_age` (string, nullable) — Maximum building age in years (one of: "new", "1", "3", "5", "7", "10", "15", "20", "25", "30")
- `walk_max` (integer, nullable) — Maximum walking minutes to the nearest station (min: 1)
- `sort` (string, nullable) — Sort order (one of: "newest", "price_asc", "price_desc", "area_asc", "area_desc", "built_oldest", "built_newest")
- `condo_facets` (array) — Amenities for condominiums (used_mansion); ignored for other property types (default: []; one of: "pets_allowed", "parking_available", "south_facing", "elevator", "roof_balcony")
- `house_facets` (array) — Amenities for houses (used_house/new_house); ignored for other property types (default: []; one of: "parking_two_cars", "has_movie", "city_gas", "ldk_15_tatami_plus", "south_facing")
- `land_facets` (array) — Conditions for land; ignored for other property types (default: []; one of: "hilltop", "regular_shape", "flat_ground", "city_gas", "public_sewer")
- `build_condition` (string, nullable) — Building-condition land filter (with/without a tie-in construction contract); land only (one of: "without", "with")
- `count` (integer, required) — Max number of results to return (min: 1)

## Response

### 200 — Successful Response

- `@type` (string) (default: "SuumoPropertyCard")
- `id` (string, required)
- `url` (string, required)
- `name` (string, nullable)
- `headline` (string, nullable)
- `price` (integer, nullable)
- `address` (string, nullable)
- `transport` (string, nullable)
- `area` (number, nullable)
- `building_area` (number, nullable)
- `land_area` (number, nullable)
- `layout` (string, nullable)
- `balcony_area` (string, nullable)
- `built_year_month` (string, nullable)
- `image` (string, nullable)

## Errors

### 422 — Validation Error

The request body did not validate

What to do: Check the fields against this schema. A URN with the wrong prefix is the most common cause.

- `detail` (array)
  - `loc` (array, required)
  - `msg` (string, required)
  - `type` (string, required)
  - `input` (any)
  - `ctx` (object)

### 408

The request ran past its time limit

What to do: 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

What to do: 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

What to do: 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

What to do: 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

What to do: Wait at least 30 seconds, then retry.

## Response envelope

Success: Array of objects (may be empty if no results)

Error: Error may coexist with partial results if it occurs mid-execution. Check X-Error header and status code.

Every response carries these 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.