/chintai/listings/averages

POST /api/chintai/listings/averages

Price: 5 credits

Get CHINTAI (チンタイ) average rents per city of a prefecture, per town of a city or per station of a railway line, filtered by layout, building type, area, walk time and building age, with the difference from the unfiltered average

How to use it

prefecture alone gives one row per city, city_code one row per town, prefecture with line_code one row per station. A row code is a city_code or town code for chintai/listings/search, or a station railway_code.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• prefecture string nullable — Prefecture: per-city averages, or the prefecture of line_code (one of: "hokkaido", "aomori", "iwate", "miyagi", "akita", "yamagata", "fukushima", "ibaraki", "tochigi", "gunma", "saitama", "chiba", "tokyo", "kanagawa", "niigata", "toyama", "ishikawa", "fukui", "yamanashi", "nagano", "gifu", "shizuoka", "aichi", "mie", "shiga", "kyoto", "osaka", "hyogo", "nara", "wakayama", "tottori", "shimane", "okayama", "hiroshima", "yamaguchi", "tokushima", "kagawa", "ehime", "kochi", "fukuoka", "saga", "nagasaki", "kumamoto", "oita", "miyazaki", "kagoshima", "okinawa")
• city_code string nullable — Japanese city code (JIS): per-town averages (examples: "13103")
• line_code string nullable — CHINTAI railway line code: per-station averages (examples: "101001")
• layouts array nullable — Room layouts; any may match (one of: "1R", "1K", "1DK", "1LDK", "2K", "2LDK", "3K", "3LDK", "4K", "4LDK", "5K", "5LDK")
• building_types array nullable — Building types; any may match (one of: "apartment", "mansion", "house")
• area_min integer nullable — Minimum floor area, m² (one of: 10, 15, 20, 25, 30, 35, 40, 45, 50, 55, 60, 70, 80, 90, 100, 110, 120, 130, 140, 150, 160, 170, 180, 190, 200)
• area_max integer nullable — Maximum floor area, m² (one of: 10, 15, 20, 25, 30, 35, 40, 45, 50, 55, 60, 70, 80, 90, 100, 110, 120, 130, 140, 150, 160, 170, 180, 190, 200)
• walk_minutes_max integer nullable — Maximum walk to the station, minutes (one of: 1, 3, 5, 7, 10, 15, 20)
• building_age_max integer nullable — Maximum building age, years; 0 is new build (one of: 0, 1, 3, 5, 7, 10, 15, 20, 25, 30)

Response

• @type string (default: "ChintaiRentAverage")
• name string required
• level string required
• code string nullable
• average_rent integer nullable
• difference integer nullable
• is_line_start boolean 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 — CHINTAI serves no rent averages for this location 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.