/suumo/properties

POST /api/suumo/properties

Price: 5 credits

Get full SUUMO (スーモ) for-sale property details by property path (or property URL): price, layout, floor area, land area and building area, floor, facing, structure, building age, address, nearest stations, management fee and repair reserve fund, total units, building coverage and floor-area ratios, land category and status, transaction type, zoning/building restrictions and remarks, handling agent and photos. Covers used/new condominiums, houses and land.

How to use it

Fetch a single SUUMO (スーモ) for-sale property (used/new mansion, house or land) by path (e.g. 'ms/chuko/tokyo/sc_minato/nc_20197336') or a full property URL. Returns name, price (JPY), address, stations (line/station/walk_min), layout, area (m2), land_area, building_area, other_area, floor, facing, structure, total_units, units_for_sale, built_year_month, management_fee, repair_reserve_fund, land_rights, use_district, building_coverage, floor_area_ratio, land_category, land_status, private_road, parking, delivery_time, transaction_type, other_fees (miscellaneous recurring costs), renovation, restrictions (other zoning/building restrictions), notes (other remarks — utilities, rebuild restrictions, free text), agent_comment (handling agent's free-text introduction), info_provided_at, next_update_at, terms_expire_at (transaction terms validity date), agent (name/license_number) and image/images. Fields populated vary by vertical (condo vs house vs land).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• property string required — SUUMO sale property path (e.g. ms/chuko/tokyo/sc_minato/nc_20197336) or a full property URL (examples: "ms/chuko/tokyo/sc_minato/nc_20197336", "https://suumo.jp/ms/chuko/tokyo/sc_minato/nc_20197336/"; minLength: 1)

Response

• @type string (default: "SuumoProperty")
• id string required
• url string required
• property_type string required
• name string nullable
• price integer 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 number nullable
• land_area number nullable
• building_area number nullable
• other_area string nullable
• floor string nullable
• facing string nullable
• structure string nullable
• total_units integer nullable
• units_for_sale integer nullable
• built_year_month string nullable
• management_fee string nullable
• repair_reserve_fund string nullable
• land_rights string nullable
• use_district string nullable
• building_coverage string nullable
• floor_area_ratio string nullable
• land_category string nullable
• land_status string nullable
• private_road string nullable
• parking string nullable
• delivery_time string nullable
• transaction_type string nullable
• other_fees string nullable
• renovation string nullable
• restrictions string nullable
• notes string nullable
• agent_comment string nullable
• info_provided_at string nullable
• next_update_at string nullable
• terms_expire_at string nullable
• agent object nullable
  • @type string (default: "SuumoListingAgent")
  • name string nullable
  • license_number 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 — Property not found (well-formed path but the property 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.