APIs / SUUMO / Rent Search

SUUMO: Rent Search

Rent Search from SUUMO as JSON. 1 credit per successful call.

GET /v1/suumo/rent-search

Parameters

Send parameters in the query string.

ParameterTypeRequiredAllowed values
prefecturestringRequiredhokkaido, 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
citystringOptionalAny
stationstringOptionalAny
linestringOptionalAny
line_groupstringOptionalAny
area_codestringOptionalAny
rent_minintegerOptionalAny
rent_maxintegerOptionalAny
area_minnumberOptionalAny
area_maxnumberOptionalAny
walk_maxintegerOptional1, 5, 7, 10, 15, 20
age_maxintegerOptional0, 1, 3, 5, 7, 10, 15, 20, 25, 30
layoutsstringOptionalAny
sortstringOptionalrecommended, price_asc, price_desc, newest, built_newest, area_desc, address
per_pageintegerOptional10, 20, 30, 50
pageintegerOptionalAny

Example request

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": "天空MURA",
        "building_type": "賃貸マンション",
        "address": "東京都新宿区西新宿6",
        "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": "天空MURA",
        "building_type": "賃貸マンション",
        "address": "東京都新宿区西新宿6",
        "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": "天空MURA",
        "building_type": "賃貸マンション",
        "address": "東京都新宿区西新宿6",
        "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.

Run this endpoint in the playground with your own parameters. 1 credit per successful call; failed calls are free.