Service
Normalized rental and sale property data extracted from SUUMO's robots-allowed public pages.
99.71%30-day uptimeAvg response2216ms
Selecting a row opens the reference for that API.
| Method | API | Path | Summary |
|---|---|---|---|
| POST | /v1/suumo/list-areas | Lists the SUUMO municipalities of one prefecture, pairing each municipality's five-digit JIS code (used by search-rentals) with its sale-search slug (used by search-properties-for-sale, search-new-mansions, and property-detail) and per-property-type sale availability. Use when you need a municipality_code or municipality_slug before calling any search operation; slugs come from SUUMO's own area pages and must never be guessed from names. Do NOT use to search listings — use suumo:search-rentals, suumo:search-properties-for-sale, or suumo:search-new-mansions instead. Returns prefecture_slug, prefecture_code, prefecture_name_ja, and areas. | |
| POST | /v1/suumo/property-detail | Returns normalized details for one used mansion, used house, or land listing identified by the property_type, prefecture_slug, municipality_slug, and property_id emitted by search-properties-for-sale. Use when the user needs the full record of a specific sale listing, such as price, layout, areas, floor, direction, management fees, handover timing, tenure, and restrictions. Do NOT use for rental units — use suumo:rental-detail instead; do NOT use for new mansions, which have no detail operation. Type-specific fields are null when that property type does not provide them. Fails when the page SUUMO returns does not match the requested identifiers. Returns property_id, url, property_type, property_name, price_yen, layout, usable_area, lot_area, building_area, address, stations, handover, and other listing facts. | |
| POST | /v1/suumo/rental-detail | Returns normalized details for one rental unit identified by the rental_id and property_code emitted by search-rentals. Use when the user needs the full record of a specific rental unit, such as floor, direction, structure, move-in availability, lease conditions, and fees. Do NOT use for sale listings — use suumo:property-detail instead; do NOT use to find rentals — use suumo:search-rentals first. Fails when the page SUUMO returns does not match the requested identifiers. Returns rental_id, property_code, url, building_name, address, stations, layout, usable_area, building_age, unit_floor, direction, availability, transaction_type, conditions, and other unit facts. |
Issue a sandbox key and make your first reservation.
APIFuse holds the partner credentials. You hold one managed key.
Receive events such as reservation confirmations and delivery updates.
Service outages and gateway errors normalise into one error model.
| POST | /v1/suumo/search-new-mansions | Searches SUUMO new-mansion (new-construction condominium) projects in one municipality identified by prefecture_slug and municipality_slug from list-areas, separately from other sale properties. Use when the user wants newly built or under-construction condominium developments; undecided prices, sales phases, and per-layout price plans (layout_plans) are preserved. Do NOT use for existing (used) condominiums, houses, or land — use suumo:search-properties-for-sale instead; do NOT use for rentals — use suumo:search-rentals instead. There is no detail operation for new mansions; use the url on each item. Returns items, total_count, returned_count, skipped_row_count, upstream_properties_per_page, page, and cursor (the next-page handle, or null on the last page). |
| POST | /v1/suumo/search-properties-for-sale | Searches SUUMO listings of one sale property type — property_type used_mansion (existing condominium), used_house, or land — in one municipality identified by prefecture_slug and municipality_slug from list-areas. Use when the user wants existing (used) condominiums, detached houses, or land for sale. Do NOT use for new-construction condominiums — use suumo:search-new-mansions instead; do NOT use for rentals — use suumo:search-rentals instead. Type-specific fields are null when that property type does not provide them. Returns items, total_count, returned_count, skipped_row_count, upstream_properties_per_page, page, and cursor (the next-page handle, or null on the last page). |
| POST | /v1/suumo/search-rentals | Searches SUUMO rental listings in one municipality (municipality_code from list-areas) with optional monthly-rent and floor-area bounds, and flattens each building's listing card into one result per unit. Use when the user wants rental units in a Japanese municipality. Do NOT use for properties for sale — use suumo:search-properties-for-sale or suumo:search-new-mansions instead; for the full record of one unit use suumo:rental-detail. Rent, deposit, key money, administration fees, area, building age, floors, layout, and station access are normalized. Returns items, upstream_gross_listing_count, returned_count, skipped_row_count, upstream_buildings_count, upstream_buildings_per_page, page, and cursor (the next-page handle, or null on the last page). |
