APIs / athome / Rent Search

athome: Rent Search

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

GET /v1/athome/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
citystringOptionalUp to 200 characters
layoutsstringOptionalAny
walk_maxintegerOptionalAny
age_maxintegerOptionalAny
pageintegerOptionalAny
per_pageintegerOptionalAny
property_typestringOptionalapartment, mansion, house
rent_minintegerOptionalAny
rent_maxintegerOptionalAny
area_minintegerOptionalAny

Example request

athome
GET/v1/athome/rent-search?prefecture=tokyo&city=shinjuku&layouts=1LDK&per_page=2&rent_max=200000
{
  "success": true,
  "data": {
    "pagination": {
      "page": 1,
      "per_page": 2,
      "total_listings": 2478,
      "total_buildings": 554,
      "total_pages": 277,
      "has_next_page": true,
      "buildings_on_page": 2
    },
    "filters": {
      "prefecture": "tokyo",
      "city": "shinjuku",
      "layouts": [
        "1LDK"
      ],
      "rent_max": 200000
    },
    "listings": [
      {
        "id": "6992715114",
        "url": "https://www.athome.co.jp/chintai/6992715114/",
        "title": "コンフォリア西早稲田 1103 1LDK",
        "rent_yen": 189000,
        "rent_man_yen": "18.9",
        "management_fee_yen": 10000,
        "management_fee_text": "10,000円",
        "deposit": "1ヶ月",
        "no_deposit": false,
        "key_money": "なし",
        "no_key_money": true,
        "layout": "1LDK",
        "area_m2": 35.79,
        "floor": 11,
        "room_number": "1103",
        "thumbnail": "https://www.athome.co.jp/image_files/path/_VmYwyI9UxeMju4b3VDwdA==.jpeg",
        "image_count": 16,
        "is_new": false,
        "has_panorama": true,
        "agency": {
          "id": "023280",
          "name": "TKホーム(有)東和企画",
          "slug": "ahto/tkhome",
          "pr": "地元・高田馬場に密着♪スタッフ全員宅建免許取得♪なんでもご相談ください♪"
        },
        "building": {
          "name": "コンフォリア西早稲田 地上13階地下1階建",
          "address": "新宿区高田馬場1丁目",
          "type": "賃貸マンション",
          "floors": "地上13階地下1階建",
          "built": "2005年2月(築21年10ヶ月)",
          "age_years": 21,
          "room_count": 6,
          "access": [
            "東京メトロ東西線 「高田馬場」駅 徒歩3分"
          ],
          "stations": [
            "…",
            "…",
            "…"
          ],
          "images": [
            "…",
            "…",
            "…"
          ]
        }
      },
      {
        "id": "1107607033",
        "url": "https://www.athome.co.jp/chintai/1107607033/",
        "title": "コンフォリア西早稲田 11階 1LDK",
        "rent_yen": 189000,
        "rent_man_yen": "18.9",
        "management_fee_yen": 10000,
        "management_fee_text": "10,000円",
        "deposit": "1ヶ月",
        "no_deposit": false,
        "key_money": "なし",
        "no_key_money": true,
        "layout": "1LDK",
        "area_m2": 35.79,
        "floor": 11,
        "thumbnail": "https://www.athome.co.jp/image_files/path/ItEK_eU9wFHfN4GEtjB7SA==.jpeg",
        "image_count": 24,
        "is_new": false,
        "has_panorama": true,
        "agency": {
          "id": "113767",
          "name": "アエラス目白店 (株)アエラス.ER",
          "slug": "ahto/a-mejiro",
          "pr": "まずは、どのような事でも「ご相談」ください。とことんお付き合いさせて頂きます。"
        },
        "building": {
          "name": "コンフォリア西早稲田 地上13階地下1階建",
          "address": "新宿区高田馬場1丁目",
          "type": "賃貸マンション",
          "floors": "地上13階地下1階建",
          "built": "2005年2月(築21年10ヶ月)",
          "age_years": 21,
          "room_count": 6,
          "access": [
            "東京メトロ東西線 「高田馬場」駅 徒歩3分"
          ],
          "stations": [
            "…",
            "…",
            "…"
          ],
          "images": [
            "…",
            "…",
            "…"
          ]
        }
      },
      {
        "id": "6992504848",
        "url": "https://www.athome.co.jp/chintai/6992504848/",
        "title": "コンフォリア西早稲田 1204 1LDK",
        "rent_yen": 200000,
        "rent_man_yen": "20",
        "management_fee_yen": 10000,
        "management_fee_text": "10,000円",
        "deposit": "1ヶ月",
        "no_deposit": false,
        "key_money": "なし",
        "no_key_money": true,
        "layout": "1LDK",
        "area_m2": 37.61,
        "floor": 12,
        "room_number": "1204",
        "thumbnail": "https://www.athome.co.jp/image_files/path/rFzQ107SUu-tvotf_nmd7A==.jpeg",
        "image_count": 16,
        "is_new": false,
        "has_panorama": true,
        "agency": {
          "id": "023280",
          "name": "TKホーム(有)東和企画",
          "slug": "ahto/tkhome",
          "pr": "地元・高田馬場に密着♪スタッフ全員宅建免許取得♪なんでもご相談ください♪"
        },
        "building": {
          "name": "コンフォリア西早稲田 地上13階地下1階建",
          "address": "新宿区高田馬場1丁目",
          "type": "賃貸マンション",
          "floors": "地上13階地下1階建",
          "built": "2005年2月(築21年10ヶ月)",
          "age_years": 21,
          "room_count": 6,
          "access": [
            "東京メトロ東西線 「高田馬場」駅 徒歩3分"
          ],
          "stations": [
            "…",
            "…",
            "…"
          ],
          "images": [
            "…",
            "…",
            "…"
          ]
        }
      }
    ]
  },
  "meta": {
    "endpoint_family": "rent_search",
    "request_id": "req_c9200d363f1f4be2b53400be873c13b1",
    "credits_charged": 1,
    "credits_remaining": 1892
  }
}
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.