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

SUUMO Areas API

GET https://scrappa.co/api/suumo/areas

List the cities (wards, cities and towns) of a prefecture with their 5-digit codes, or the towns of one city. Use the city codes as `city` in the rent and sale search. `listing_count` is the number of rental listings SUUMO shows for the area.

SUUMO Areas API 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/suumo/areas
Auth header
x-api-key
Cost
1 credit/request
prefecture = example
Response preview
200 OK
{
    "data": {
        "cities": [
            {
                "code": "13101",
                "name": "\u5343\u4ee3\u7530\u533a",
                "listing_count": 32654
            },
            {
                "code": "13104",
                "name": "\u65b0\u5bbf\u533a",
                "listing_count": 123078
            }
        ],
...

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.

1 optional filter 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

A 5-digit city code from the cities list, e.g. 13104. Returns the towns of that city instead of the cities.

Example value example

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": {
        "cities": [
            {
                "code": "13101",
                "name": "\u5343\u4ee3\u7530\u533a",
                "listing_count": 32654
            },
            {
                "code": "13104",
                "name": "\u65b0\u5bbf\u533a",
                "listing_count": 123078
            }
        ],
        "prefecture": "tokyo"
    },
    "meta": {
        "billable": true,
        "endpoint_family": "areas"
    },
    "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.