/suumo/listings/averages

POST /api/suumo/listings/averages

Price: 5 credits

Get the SUUMO (スーモ) rental rent-average (家賃相場) benchmark for a ward or station: the typical monthly rent broken down by layout (1R, 1K, 1LDK, 2LDK, 3LDK, ...) for a chosen building type (mansion, apartment or house). Also returns the rent averages of neighbouring wards/stations.

How to use it

Get the SUUMO (スーモ) rental rent benchmark (家賃相場) for one location. Provide location as a ward path ('tokyo/sc_chiyoda'), a station path ('tokyo/ek_06640') or a full soba URL; optionally building_type (mansion/apartment/house, default mansion). Returns one object with name, pref, location_type (ward/station), building_type, updated_at, averages (layout + average monthly rent in JPY) and nearby (neighbouring wards/stations with their average rent).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• location string required — Ward path ('tokyo/sc_chiyoda'), station path ('tokyo/ek_06640'), or full SUUMO soba URL (examples: "tokyo/sc_chiyoda", "tokyo/ek_06640", "osaka/sc_osakashikita"; minLength: 1)
• building_type string — Building type the rent average is computed for (default: "mansion"; one of: "mansion", "apartment", "house")

Response

• @type string (default: "SuumoRentAverage")
• id string required
• location_type string required
• location_code string required
• pref string required
• name string required
• building_type string required
• url string required
• updated_at string nullable
• averages array (default: [])
  • @type string (default: "SuumoRentAverageLayout")
  • layout string required
  • rent integer nullable
• nearby array (default: [])
  • @type string (default: "SuumoRentAverageNearby")
  • name string required
  • rent integer nullable
  • url 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 — No rent-average data for this location (well-formed path but no benchmark page exists) 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.