--- title: "SUUMO API: JSON data, 6 endpoints, 1 credit per call" description: "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." url: https://perceptlayer.com/apis/suumo --- [APIs](https://perceptlayer.com/apis) / [Real estate](https://perceptlayer.com/verticals/real-estate) / SUUMO 1 credit per call 6 endpoints 26 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 key](https://perceptlayer.com/signup) Run 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 OK JSON X-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\_name string | building\_type string | address string | stations object\[\] | age\_text string | age\_years integer | floors\_text string | floors\_above integer | floors\_below integer | thumbnail url | id string | building\_id string | source\_url url | floor string | rent\_text string | rent\_yen integer | admin\_fee\_text string | admin\_fee\_yen integer | deposit\_text string | deposit\_yen integer | key\_money\_text string | key\_money\_yen integer | layout string | area\_text string | area\_m2 number | images string\[\] | | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | 1 | 天空ＭＵＲＡ | 賃貸マンション | 東京都新宿区西新宿６ | \[3 items\] | 築11年 | 11 | 地下1地上13階建 | 13 | 1 | https://img01.suumo.com/front/gazo/fr/bukken/127/100479868127/100479868127\_gw.jpg | 000110744271 | 100530809314 | https://suumo.jp/chintai/jnc\_000110744271/ | 4階 | 8.9万円 | 89000 | 4000円 | 4000 | 8.9万円 | 89000 | 8.9万円 | 89000 | 1K | 12.92m2 | 12.92 | \[3 items\] | | 2 | 天空ＭＵＲＡ | 賃貸マンション | 東京都新宿区西新宿６ | \[3 items\] | 築11年 | 11 | 地下1地上13階建 | 13 | 1 | https://img01.suumo.com/front/gazo/fr/bukken/127/100479868127/100479868127\_gw.jpg | 000110744273 | 100528753269 | https://suumo.jp/chintai/jnc\_000110744273/ | 8階 | 9.3万円 | 93000 | 4000円 | 4000 | 9.3万円 | 93000 | 9.3万円 | 93000 | 1K | 12.81m2 | 12.81 | \[3 items\] | | 3 | 天空ＭＵＲＡ | 賃貸マンション | 東京都新宿区西新宿６ | \[3 items\] | 築11年 | 11 | 地下1地上13階建 | 13 | 1 | https://img01.suumo.com/front/gazo/fr/bukken/127/100479868127/100479868127\_gw.jpg | 000110744272 | 100479868127 | https://suumo.jp/chintai/jnc\_000110744272/ | 5階 | 9.5万円 | 95000 | 4000円 | 4000 | 9.5万円 | 95000 | 9.5万円 | 95000 | 1K | 13.26m2 | 13.26 | \[3 items\] | Recorded from our API · 3 items shown · 26 datapoints per item GET /v1/suumo/rent-search?prefecture=tokyo&city=13104&rent\_max=100000&walk\_max=10 26 datapoints ### Identity - building\_name string - building\_type string - id string - building\_id string ### Contact - source\_url url ### Location - address string - area\_text string - area\_m2 number ### Reputation - images string\[\] ### Price - admin\_fee\_text string - admin\_fee\_yen integer ### Other - stations object\[\] - age\_text string - age\_years integer - floors\_text string - floors\_above integer - floors\_below integer - thumbnail url - floor string - rent\_text string - rent\_yen integer - deposit\_text string - deposit\_yen integer - key\_money\_text string - key\_money\_yen integer - layout string Playground ## Run this API cURL shell ``` 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. | Endpoint | Required parameters | Cost | | --- | --- | --- | | [GET `/v1/suumo/areas`](https://perceptlayer.com/apis/suumo/areas) | `prefecture` +1 optional | 1 credit | | [GET `/v1/suumo/lines`](https://perceptlayer.com/apis/suumo/lines) | `prefecture` +3 optional | 1 credit | | [GET `/v1/suumo/rent-listing`](https://perceptlayer.com/apis/suumo/rent-listing) | `id` | 1 credit | | [GET `/v1/suumo/rent-search`](https://perceptlayer.com/apis/suumo/rent-search) | `prefecture` +15 optional | 1 credit | | [GET `/v1/suumo/sale-listing`](https://perceptlayer.com/apis/suumo/sale-listing) | `id` `property_type` `prefecture` `city` | 1 credit | | [GET `/v1/suumo/sale-search`](https://perceptlayer.com/apis/suumo/sale-search) | `prefecture` +14 optional | 1 credit | Overview ## About the SUUMO API ## 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 estate JSON REST MCP ### More real estate APIs [28Hse](https://perceptlayer.com/apis/28hse) [4zida](https://perceptlayer.com/apis/4zida) [591](https://perceptlayer.com/apis/591-house) [99.co](https://perceptlayer.com/apis/99co) [99acres](https://perceptlayer.com/apis/99acres) [Adondevivir](https://perceptlayer.com/apis/adondevivir) [Apartment List](https://perceptlayer.com/apis/apartment-list) [Apartments.com](https://perceptlayer.com/apis/apartments-com) [Aqar](https://perceptlayer.com/apis/aqar) [Aqarmap](https://perceptlayer.com/apis/aqarmap) [Argenprop](https://perceptlayer.com/apis/argenprop) [athome](https://perceptlayer.com/apis/athome) 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 key](https://perceptlayer.com/signup) [Read the docs](https://docs.perceptlayer.com)