Skip to content
Scrappa Get API key
SUUMO API 1 credit/request

SUUMO Rent Search API

GET https://scrappa.co/api/suumo/rent/search

Search rental rooms (chintai) on SUUMO by prefecture and city, or by train station. Filter by rent, layout (madori), area, walk time to the station and building age, and sort by price, age or area. Each listing is one room with its building. Japanese text is returned as published, next to parsed numbers: `rent_yen`, `admin_fee_yen`, `deposit_yen`, `key_money_yen`, `area_m2`, `age_years` and `walk_min`. Rent, area and age filters are checked again on the parsed values, so a returned room never breaks a filter (`filtered_out` counts the rooms removed from the page). The walk time filter matches any station of a building, so the stations listed on a result can include a longer walk. Pages hold up to `per_page` buildings. There is no reliable total, so use `has_next_page`. Telephone numbers are not returned.

SUUMO Rent Search API 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/suumo/rent/search
Auth header
x-api-key
Cost
1 credit/request
prefecture = example
Response preview
200 OK
{
    "data": {
        "filters": {
            "cities": [
                "13104"
            ],
            "rent_max": 100000,
            "walk_max": 10,
            "prefecture": "tokyo"
        },
        "listings": [
            {
                "id": "000108054369",
                "floor": "B1\u968e",
...

Parameters

Start with the required fields, then add optional filters only when your use case needs them.

Runnable path

1 required parameter needed before sending a request.

15 optional filters available.

prefecture string Required

Prefecture as a lower-case English name: tokyo, osaka, kanagawa, hokkaido and so on (all 47).

Example value example
city string Optional

One or more 5-digit city codes from the areas endpoint, separated by commas (maximum 10), e.g. 13104 for Shinjuku. Omit for the whole prefecture. Not with station.

Example value example
station string Optional

One or more 9-digit station codes from the lines endpoint, separated by commas (maximum 10). Needs line, line_group and area_code.

Example value example
line string Optional

4-digit line code from the lines endpoint. Required with station.

Example value example
line_group string Optional

The line_group value of that line in the lines endpoint. Required with station.

Example value example
area_code string Optional

The area_code value of the lines endpoint. Required with station.

Example value example
rent_min integer Optional

Minimum monthly rent in yen, without the management fee.

Example value 10
rent_max integer Optional

Maximum monthly rent in yen, without the management fee. Must not be below rent_min.

Example value 10
area_min number Optional

Minimum floor area in square meters.

Example value 10
area_max number Optional

Maximum floor area in square meters. Must not be below area_min.

Example value 10
walk_max integer Optional

Maximum walking minutes to a station: 1, 5, 7, 10, 15 or 20.

Example value 10
age_max integer Optional

Maximum building age in years: 0 (new), 1, 3, 5, 7, 10, 15, 20, 25 or 30.

Example value 10
layouts string Optional

Layouts separated by commas: 1R, 1K, 1DK, 1LDK, 2K, 2DK, 2LDK, 3K, 3DK, 3LDK, 4K, 4DK, 4LDK, 5K+. SUUMO counts 1SLDK and similar with the plain layout.

Example value example
sort string Optional

recommended (default), price_asc, price_desc (rent plus management fee), newest, built_newest, area_desc or address.

Example value relevance
per_page integer Optional

Buildings per page: 10, 20, 30 or 50.

Example value 10
page integer Optional

Page number, 1-based, up to 100. A page past the last page returns an empty list with the page you asked for.

Example value 1

Response Schema

Example response fields are illustrative; inspect the JSON before integrating.

Example response fields

Scan these fields before integrating.

data meta success
JSON Response
200 OK
{
    "data": {
        "filters": {
            "cities": [
                "13104"
            ],
            "rent_max": 100000,
            "walk_max": 10,
            "prefecture": "tokyo"
        },
        "listings": [
            {
                "id": "000108054369",
                "floor": "B1\u968e",
                "images": [
                    "https://img01.suumo.com/front/gazo/fr/bukken/976/100284463976/100284463976_go.jpg"
                ],
                "layout": "\u30ef\u30f3\u30eb\u30fc\u30e0",
                "address": "\u6771\u4eac\u90fd\u65b0\u5bbf\u533a\u65b0\u5bbf7",
                "area_m2": 35.7,
                "age_text": "\u7bc954\u5e74",
                "rent_yen": 80000,
                "stations": [
                    {
                        "raw": "\u90fd\u55b6\u5927\u6c5f\u6238\u7dda/\u82e5\u677e\u6cb3\u7530\u99c5 \u6b697\u5206",
                        "line": "\u90fd\u55b6\u5927\u6c5f\u6238\u7dda",
                        "station": "\u82e5\u677e\u6cb3\u7530\u99c5",
                        "walk_min": 7
                    },
                    {
                        "raw": "\u6771\u4eac\u30e1\u30c8\u30ed\u526f\u90fd\u5fc3\u7dda/\u6771\u65b0\u5bbf\u99c5 \u6b698\u5206",
                        "line": "\u6771\u4eac\u30e1\u30c8\u30ed\u526f\u90fd\u5fc3\u7dda",
                        "station": "\u6771\u65b0\u5bbf\u99c5",
                        "walk_min": 8
                    }
                ],
                "age_years": 54,
                "area_text": "35.7m2",
                "rent_text": "8\u4e07\u5186",
                "thumbnail": "https://img01.suumo.com/front/gazo/fr/bukken/976/100284463976/100284463976_gw.jpg",
                "source_url": "https://suumo.jp/chintai/jnc_000108054369/",
                "building_id": "100284463976",
                "deposit_yen": 80000,
                "floors_text": "\u5730\u4e0b1\u5730\u4e0a5\u968e\u5efa",
                "deposit_text": "8\u4e07\u5186",
                "floors_above": 5,
                "floors_below": 1,
                "building_name": "\u30cf\u30a4\u30e0\u8352\u5ddd",
                "building_type": "\u8cc3\u8cb8\u30de\u30f3\u30b7\u30e7\u30f3",
                "key_money_yen": 80000,
                "key_money_text": "8\u4e07\u5186"
            }
        ],
        "pagination": {
            "page": 1,
            "per_page": 20,
            "has_next_page": true,
            "buildings_on_page": 20
        }
    },
    "meta": {
        "billable": true,
        "endpoint_family": "rent_search"
    },
    "success": true
}

Errors

Handle these documented responses before retrying or showing customer-facing failures.

404

HTTP 404

The listing does not exist or is no longer online. This response is not billable.

422

HTTP 422

A parameter or filter is missing, invalid or not available for the property type. This response is not billable.

503

HTTP 503

SUUMO is temporarily unavailable or answered a page that no longer matches the documented contract. Retry the request. This response is not billable.

Generate Code with AI

Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.

Try It Live

Test this endpoint in our interactive playground with real data.