/suumo/listings/search

POST /api/suumo/listings/search

Price: 10 credits

Search SUUMO (スーモ) rental listings by prefecture, optionally narrowed to a railway line and specific stations, with filters: rent range, floor-area range, walking distance to the nearest station, floor-plan layout, building type, maximum building age, rent-cost conditions (management fee included, no key money, no deposit), an extensive amenity catalogue (e.g. separate bath/toilet, auto-lock, pets allowed, floor heating, tower mansion, barrier-free, free internet) and sort order (recommended, cheapest/most expensive rent, newest listings, newest building, largest area, by address). Returns listing cards with building name and type, address, nearest stations, age, floor, rent, management fee, deposit/key money, layout, area and image.

How to use it

Search SUUMO (スーモ) rental listings. Provide pref (e.g. 'tokyo', 'osaka', 'kanagawa'). Optionally narrow by line (railway line name, e.g. 'JR山手線') and stations (station names along that line, e.g. ['新宿','渋谷'] — requires line). Other filters: rent_min/rent_max (JPY/month), area_min/area_max (m2), walk_max (minutes to nearest station), layouts (one_room/1k/1dk/1ldk/2k/.../5k_plus), building_types (mansion/apartment/house/other), max_age (e.g. within_10_years), rent_conditions (management_fee_included/no_key_money/no_deposit), facets (separate_bath_toilet/auto_lock/pets_allowed/floor_heating/tower_mansion/barrier_free/...). Sort by recommended/rent_asc/rent_desc/newest/age_newest/area_desc/by_address. Each result has id ('jnc_{building_id}/{room_id}'), url, building_name, building_type, address, stations (line/station/walk_min), age, floor, total_floors, rent, management_fee, deposit, key_money, layout, area 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")
• 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: [])
• rent_min integer nullable — Minimum monthly rent (JPY) (min: 0)
• rent_max integer nullable — Maximum monthly rent (JPY) (min: 0)
• area_min number nullable — Minimum floor area (m2) (min: 0)
• area_max number nullable — Maximum floor area (m2) (min: 0)
• walk_max integer nullable — Maximum walking minutes to the nearest station (min: 1)
• layouts array — Floor-plan layouts to include (default: []; one of: "one_room", "1k", "1dk", "1ldk", "2k", "2dk", "2ldk", "3k", "3dk", "3ldk", "4k", "4dk", "4ldk", "5k_plus")
• building_types array — Building types to include (default: []; one of: "mansion", "apartment", "house", "other")
• max_age string nullable — Maximum building age (one of: "new", "within_1_year", "within_3_years", "within_5_years", "within_7_years", "within_10_years", "within_15_years", "within_20_years", "within_25_years", "within_30_years")
• facets array — Required amenities and conditions (all must match) (default: []; one of: "above_2nd_floor", "top_floor", "corner_room", "south_facing", "first_floor", "gas_stove_ready", "ih_stove", "two_plus_burners", "all_electric", "system_kitchen", "counter_kitchen", "separate_bath_toilet", "washlet", "bathroom_dryer", "reheating_bath", "shower_room", "internet_available", "bs_antenna", "cs_antenna", "cable_tv", "free_internet", "indoor_washer_space", "separate_washroom", "flooring", "maisonette", "loft", "soundproof_room", "basement", "furnished", "air_conditioner", "floor_heating", "kerosene_heating", "gas_heating", "under_floor_storage", "shoe_box", "trunk_room", "walk_in_closet", "auto_lock", "caretaker", "video_intercom", "security_company", "security_camera", "parking", "bicycle_parking", "motorcycle_parking", "elevator", "delivery_box", "on_site_garbage_area", "balcony", "roof_balcony", "private_garden", "parking_two_plus", "on_site_parking", "city_gas", "propane_gas", "barrier_free", "designers", "condo_for_rent", "no_guarantor", "tower_mansion", "reformed", "renovated", "online_contract", "initial_cost_card_payment", "rent_card_payment", "immediate_move_in", "pets_allowed", "instruments_allowed", "office_use_allowed", "room_share_allowed", "exclude_fixed_term", "diy_allowed", "women_only", "customizable", "elderly_welcome", "lgbt_friendly", "free_rent", "specified_quality_rental", "floor_plan_image", "photo", "new_today", "new_recent", "property_video", "panorama")
• rent_conditions array — Rent-cost conditions to require (management fee included, no key money, no deposit) (default: []; one of: "management_fee_included", "no_key_money", "no_deposit")
• sort string — Sort order (default: "recommended"; one of: "recommended", "rent_asc", "rent_desc", "newest", "age_newest", "area_desc", "by_address")
• count integer required — Max number of results to return (min: 1)

Response

• @type string (default: "SuumoListingCard")
• id string required
• building_id string required
• room_id string required
• url string required
• building_name string nullable
• building_type string nullable
• address string nullable
• stations array (default: [])
  • @type string (default: "SuumoStation")
  • line string nullable
  • station string nullable
  • walk_min integer nullable
• age string nullable
• total_floors string nullable
• floor string nullable
• rent integer nullable
• management_fee integer nullable
• deposit string nullable
• key_money string nullable
• layout string nullable
• area number nullable
• image string nullable

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.