Sign inGet a free API keyDashboard
Menu

APIs / Real estate / SUUMO

1 credit per call6 endpoints26 datapoints

SUUMO API

SUUMO API for Japanese rentals and homes for sale, with rent, fees, deposits, layouts, stations, areas and rail lines as JSON. 1 credit per successful call.

Get a free API keyRun it below
SUUMO
GET/v1/suumo/rent-search?prefecture=tokyo&city=13104&rent_max=100000&walk_max=10
{
  "success": true,
  "data": {
    "pagination": {
      "page": 1,
      "per_page": 20,
      "has_next_page": true,
      "buildings_on_page": 20
    },
    "filters": {
      "prefecture": "tokyo",
      "cities": [
        "13104"
      ],
      "rent_max": 100000,
      "walk_max": 10
    },
    "listings": [
      {
        "building_name": "天空ＭＵＲＡ",
        "building_type": "賃貸マンション",
        "address": "東京都新宿区西新宿６",
        "stations": [
          {
            "line": "東京メトロ丸ノ内線",
            "station": "西新宿駅",
            "walk_min": 8,
            "raw": "東京メトロ丸ノ内線/西新宿駅 歩8分"
          },
          {
            "line": "都営大江戸線",
            "station": "都庁前駅",
            "walk_min": 9,
            "raw": "都営大江戸線/都庁前駅 歩9分"
          },
          {
            "line": "都営大江戸線",
            "station": "西新宿五丁目駅",
            "walk_min": 8,
            "raw": "都営大江戸線/西新宿五丁目駅 歩8分"
          }
        ],
        "age_text": "築11年",
        "age_years": 11,
        "floors_text": "地下1地上13階建",
        "floors_above": 13,
        "floors_below": 1,
        "thumbnail": "https://img01.suumo.com/front/gazo/fr/bukken/127/100479868127/100479868127_gw.jpg",
        "id": "000110744271",
        "building_id": "100530809314",
        "source_url": "https://suumo.jp/chintai/jnc_000110744271/",
        "floor": "4階",
        "rent_text": "8.9万円",
        "rent_yen": 89000,
        "admin_fee_text": "4000円",
        "admin_fee_yen": 4000,
        "deposit_text": "8.9万円",
        "deposit_yen": 89000,
        "key_money_text": "8.9万円",
        "key_money_yen": 89000,
        "layout": "1K",
        "area_text": "12.92m2",
        "area_m2": 12.92,
        "images": [
          "https://img01.suumo.com/front/gazo/fr/bukken/314/100530809314/100530809314_go.jpg",
          "https://img01.suumo.com/front/gazo/fr/bukken/314/100530809314/100530809314_co.jpg",
          "https://img01.suumo.com/front/gazo/fr/bukken/314/100530809314/100530809314_11o.jpg"
        ]
      },
      {
        "building_name": "天空ＭＵＲＡ",
        "building_type": "賃貸マンション",
        "address": "東京都新宿区西新宿６",
        "stations": [
          {
            "line": "東京メトロ丸ノ内線",
            "station": "西新宿駅",
            "walk_min": 8,
            "raw": "東京メトロ丸ノ内線/西新宿駅 歩8分"
          },
          {
            "line": "都営大江戸線",
            "station": "都庁前駅",
            "walk_min": 9,
            "raw": "都営大江戸線/都庁前駅 歩9分"
          },
          {
            "line": "都営大江戸線",
            "station": "西新宿五丁目駅",
            "walk_min": 8,
            "raw": "都営大江戸線/西新宿五丁目駅 歩8分"
          }
        ],
        "age_text": "築11年",
        "age_years": 11,
        "floors_text": "地下1地上13階建",
        "floors_above": 13,
        "floors_below": 1,
        "thumbnail": "https://img01.suumo.com/front/gazo/fr/bukken/127/100479868127/100479868127_gw.jpg",
        "id": "000110744273",
        "building_id": "100528753269",
        "source_url": "https://suumo.jp/chintai/jnc_000110744273/",
        "floor": "8階",
        "rent_text": "9.3万円",
        "rent_yen": 93000,
        "admin_fee_text": "4000円",
        "admin_fee_yen": 4000,
        "deposit_text": "9.3万円",
        "deposit_yen": 93000,
        "key_money_text": "9.3万円",
        "key_money_yen": 93000,
        "layout": "1K",
        "area_text": "12.81m2",
        "area_m2": 12.81,
        "images": [
          "https://img01.suumo.com/front/gazo/fr/bukken/269/100528753269/100528753269_go.jpg",
          "https://img01.suumo.com/front/gazo/fr/bukken/269/100528753269/100528753269_co.jpg",
          "https://img01.suumo.com/front/gazo/fr/bukken/269/100528753269/100528753269_1o.jpg"
        ]
      },
      {
        "building_name": "天空ＭＵＲＡ",
        "building_type": "賃貸マンション",
        "address": "東京都新宿区西新宿６",
        "stations": [
          {
            "line": "東京メトロ丸ノ内線",
            "station": "西新宿駅",
            "walk_min": 8,
            "raw": "東京メトロ丸ノ内線/西新宿駅 歩8分"
          },
          {
            "line": "都営大江戸線",
            "station": "都庁前駅",
            "walk_min": 9,
            "raw": "都営大江戸線/都庁前駅 歩9分"
          },
          {
            "line": "都営大江戸線",
            "station": "西新宿五丁目駅",
            "walk_min": 8,
            "raw": "都営大江戸線/西新宿五丁目駅 歩8分"
          }
        ],
        "age_text": "築11年",
        "age_years": 11,
        "floors_text": "地下1地上13階建",
        "floors_above": 13,
        "floors_below": 1,
        "thumbnail": "https://img01.suumo.com/front/gazo/fr/bukken/127/100479868127/100479868127_gw.jpg",
        "id": "000110744272",
        "building_id": "100479868127",
        "source_url": "https://suumo.jp/chintai/jnc_000110744272/",
        "floor": "5階",
        "rent_text": "9.5万円",
        "rent_yen": 95000,
        "admin_fee_text": "4000円",
        "admin_fee_yen": 4000,
        "deposit_text": "9.5万円",
        "deposit_yen": 95000,
        "key_money_text": "9.5万円",
        "key_money_yen": 95000,
        "layout": "1K",
        "area_text": "13.26m2",
        "area_m2": 13.26,
        "images": [
          "https://img01.suumo.com/front/gazo/fr/bukken/127/100479868127/100479868127_ro.jpg",
          "https://img01.suumo.com/front/gazo/fr/bukken/127/100479868127/100479868127_co.jpg",
          "https://img01.suumo.com/front/gazo/fr/bukken/127/100479868127/100479868127_go.jpg"
        ]
      }
    ]
  },
  "meta": {
    "endpoint_family": "rent_search",
    "request_id": "req_10f2461c872b4ff7b034294a0968830b",
    "credits_charged": 1,
    "credits_remaining": 1808
  }
}
200 OKJSONX-Credits-Used: 1
Recorded from our API and shortened.

Sample data

What one call returns

A recorded run of rent-search: the fields and shapes you will get, shortened to 3 items.

#building_namestringbuilding_typestringaddressstringstationsobject[]age_textstringage_yearsintegerfloors_textstringfloors_aboveintegerfloors_belowintegerthumbnailurlidstringbuilding_idstringsource_urlurlfloorstringrent_textstringrent_yenintegeradmin_fee_textstringadmin_fee_yenintegerdeposit_textstringdeposit_yenintegerkey_money_textstringkey_money_yenintegerlayoutstringarea_textstringarea_m2numberimagesstring[]
1天空ＭＵＲＡ賃貸マンション東京都新宿区西新宿６[3 items]築11年11地下1地上13階建131https://img01.suumo.com/front/gazo/fr/bukken/127/100479868127/100479868127_gw.jpg000110744271100530809314https://suumo.jp/chintai/jnc_000110744271/4階8.9万円890004000円40008.9万円890008.9万円890001K12.92m212.92[3 items]
2天空ＭＵＲＡ賃貸マンション東京都新宿区西新宿６[3 items]築11年11地下1地上13階建131https://img01.suumo.com/front/gazo/fr/bukken/127/100479868127/100479868127_gw.jpg000110744273100528753269https://suumo.jp/chintai/jnc_000110744273/8階9.3万円930004000円40009.3万円930009.3万円930001K12.81m212.81[3 items]
3天空ＭＵＲＡ賃貸マンション東京都新宿区西新宿６[3 items]築11年11地下1地上13階建131https://img01.suumo.com/front/gazo/fr/bukken/127/100479868127/100479868127_gw.jpg000110744272100479868127https://suumo.jp/chintai/jnc_000110744272/5階9.5万円950004000円40009.5万円950009.5万円950001K13.26m213.26[3 items]

Recorded from our API · 3 items shown · 26 datapoints per itemGET /v1/suumo/rent-search?prefecture=tokyo&city=13104&rent_max=100000&walk_max=10

26 datapoints

Identity

  • building_namestring
  • building_typestring
  • idstring
  • building_idstring

Contact

  • source_urlurl

Location

  • addressstring
  • area_textstring
  • area_m2number

Reputation

  • imagesstring[]

Price

  • admin_fee_textstring
  • admin_fee_yeninteger

Other

  • stationsobject[]
  • age_textstring
  • age_yearsinteger
  • floors_textstring
  • floors_aboveinteger
  • floors_belowinteger
  • thumbnailurl
  • floorstring
  • rent_textstring
  • rent_yeninteger
  • deposit_textstring
  • deposit_yeninteger
  • key_money_textstring
  • key_money_yeninteger
  • layoutstring

Playground

Run this API

cURLshell
curl "https://api.perceptlayer.com/v1/suumo/rent-search?prefecture=tokyo&city=13104&rent_max=100000&walk_max=10" \
  -H "X-API-Key: $API_KEY"

SUUMO · 6 endpoints

Endpoints

Every endpoint takes the same key. Open one for its parameters and an example request.

EndpointRequired parametersCost
GET/v1/suumo/areas
prefecture+1 optional
1 credit
GET/v1/suumo/lines
prefecture+3 optional
1 credit
GET/v1/suumo/rent-listing
id
1 credit
GET/v1/suumo/rent-search
prefecture+15 optional
1 credit
GET/v1/suumo/sale-listing
idproperty_typeprefecturecity
1 credit
GET/v1/suumo/sale-search
prefecture+14 optional
1 credit

Overview

What you can get

The SUUMO API returns SUUMO property data as JSON through 6 endpoints. Searches and lookups take a prefecture, one of Japan's 47 (tokyo, osaka, hokkaido and so on).

  • Rentals: rent-search takes a prefecture, with city, station, line, line_group, area_code, rent_min, rent_max, area_min, area_max, walk_max (1, 5, 7, 10, 15 or 20 minutes), age_max (0, 1, 3, 5, 7, 10, 15, 20, 25 or 30 years), layouts, sort (recommended, price_asc, price_desc, newest, built_newest, area_desc or address), per_page (10, 20, 30 or 50) and page. rent-listing takes an id.
  • For sale: sale-search takes a prefecture, with property_type (used_mansion, new_mansion, new_house or used_house), city, price_min, price_max, area_min, area_max, land_area_min, land_area_max, walk_max (1, 3, 5, 7, 10, 15 or 20), age_max (1, 3, 5, 10, 15, 20, 25 or 30), layouts, sort (newest, address_asc, price_asc, price_desc, area_desc, area_asc, built_newest or built_oldest), per_page (10, 20, 30, 50 or 100) and page. sale-listing takes an id, property_type, prefecture and city.
  • Areas and lines: areas takes a prefecture, with city; lines takes a prefecture, with line, line_group and area_code.

The recorded rent-search for Tokyo city code 13104 (Shinjuku, by the addresses returned) with rent_max=100000 and walk_max=10 returns pagination with per_page (20), has_next_page and buildings_on_page, the filters, and listings, each with id, building_id, building_name, building_type, address, stations (line, station, walk_min), age_years, floors_above, floor, rent_yen, admin_fee_yen, deposit_yen, key_money_yen, layout, area_m2, source_url and images.

How a call works

Search rentals: GET /v1/suumo/rent-search?prefecture=tokyo&city=13104&rent_max=100000&walk_max=10 with your key in the X-API-Key header. Each listing's id is what rent-listing takes. Check has_next_page before asking for the next page. Every successful call costs 1 credit; failed calls cost nothing.

Real estateJSONRESTMCP

More real estate APIs

28Hse4zida59199.co99acresAdondevivirApartment ListApartments.comAqarAqarmapArgenpropathome

Use cases

Track rents by layout and ward in Tokyo and other prefectures

Use the SUUMO API to track rents by layout and ward in Tokyo and other prefectures

Compare move-in costs from `deposit_yen`, `key_money_yen` and `admin_fee_yen`

Use the SUUMO API to compare move-in costs from `deposit_yen`, `key_money_yen` and `admin_fee_yen`

Find rentals within a walk of a station with `station` and `walk_max`

Use the SUUMO API to find rentals within a walk of a station with `station` and `walk_max`

Watch used and new condominiums and houses for sale with `sale-search`

Use the SUUMO API to watch used and new condominiums and houses for sale with `sale-search`

FAQ

Questions

Do I need a SUUMO account?

No. You call this SUUMO API with your Perceptlayer key in the `X-API-Key` header, with no SUUMO login.

How much does the SUUMO API cost?

Each successful call costs one credit. New accounts get free credits to start, and credit packs bring the price down as you scale.

What format are responses in?

Every endpoint returns JSON, with no HTML parsing on your side.

Are rents and fees given as numbers?

Yes. Each listing returns `rent_yen`, `admin_fee_yen`, `deposit_yen` and `key_money_yen` in yen, next to the site's text, such as `rent_text`.

Should I build a SUUMO scraper instead?

You can, but a SUUMO scraper is code you maintain: page changes break it, requests get blocked, and SUUMO's terms govern how you collect data. The SUUMO API gives you 6 endpoints of named JSON fields for 1 credit per successful call, and failed calls cost nothing. A scraper makes sense only for data these endpoints don't return, so check the response in the playground on this page first.

Try the SUUMO API with 100 free credits

No credit card. Failed calls are never billed.

Get a free API keyRead the docs