Sign inGet a free API keyDashboard
Menu

APIs / Real estate / athome

1 credit per call7 endpoints21 datapoints

athome API

athome API for Japanese rentals and homes for sale: search by prefecture and city, listing details, agencies and places as JSON. 1 credit per successful call.

Get a free API keyRun it below
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.

Sample data

What one call returns

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

#idstringurlurltitlestringrent_yenintegerrent_man_yenstringmanagement_fee_yenintegermanagement_fee_textstringdepositstringno_depositbooleankey_moneystringno_key_moneybooleanlayoutstringarea_m2numberfloorintegerroom_numberstringthumbnailurlimage_countintegeris_newbooleanhas_panoramabooleanagencyobjectbuildingobject
16992715114https://www.athome.co.jp/chintai/6992715114/コンフォリア西早稲田 1103 1LDK18900018.91000010,000円1ヶ月falseなしtrue1LDK35.79111103https://www.athome.co.jp/image_files/path/_VmYwyI9UxeMju4b3VDwdA==.jpeg16falsetrue{4 fields}{10 fields}
21107607033https://www.athome.co.jp/chintai/1107607033/コンフォリア西早稲田 11階 1LDK18900018.91000010,000円1ヶ月falseなしtrue1LDK35.7911—https://www.athome.co.jp/image_files/path/ItEK_eU9wFHfN4GEtjB7SA==.jpeg24falsetrue{4 fields}{10 fields}
36992504848https://www.athome.co.jp/chintai/6992504848/コンフォリア西早稲田 1204 1LDK200000201000010,000円1ヶ月falseなしtrue1LDK37.61121204https://www.athome.co.jp/image_files/path/rFzQ107SUu-tvotf_nmd7A==.jpeg16falsetrue{4 fields}{10 fields}

Recorded from our API · 3 items shown · 21 datapoints per itemGET /v1/athome/rent-search?prefecture=tokyo&city=shinjuku&layouts=1LDK&per_page=2&rent_max=200000

21 datapoints

Identity

  • idstring
  • titlestring

Contact

  • urlurl

Location

  • area_m2number

Reputation

  • image_countinteger

Price

  • management_fee_yeninteger
  • management_fee_textstring

Other

  • rent_yeninteger
  • rent_man_yenstring
  • depositstring
  • no_depositboolean
  • key_moneystring
  • no_key_moneyboolean
  • layoutstring
  • floorinteger
  • room_numberstring
  • thumbnailurl
  • is_newboolean
  • has_panoramaboolean
  • agencyobject
  • buildingobject

Playground

Run this API

cURLshell
curl "https://api.perceptlayer.com/v1/athome/rent-search?prefecture=tokyo&city=shinjuku&layouts=1LDK&per_page=2&rent_max=200000" \
  -H "X-API-Key: $API_KEY"

athome · 7 endpoints

Endpoints

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

EndpointRequired parametersCost
GET/v1/athome/agency
slug+1 optional
1 credit
GET/v1/athome/autocomplete
keyword+2 optional
1 credit
GET/v1/athome/places
query
1 credit
GET/v1/athome/rent-detail
id
1 credit
GET/v1/athome/rent-search
prefecture+10 optional
1 credit
GET/v1/athome/sale-detail
id
1 credit
GET/v1/athome/sale-search
prefecture+10 optional
1 credit

Overview

What you can get

The athome API returns athome property data for Japan as JSON through 7 endpoints. Searches take a prefecture by romanised name, from hokkaido to okinawa (all 47).

  • Rent search: rent-search takes a prefecture, with city, layouts, walk_max, age_max, property_type (apartment, mansion or house), rent_min, rent_max, area_min, page and per_page.
  • Sale search: sale-search takes a prefecture, with city, layouts, walk_max, age_max, price_min, price_max, area_min, area_max, page and per_page.
  • Listings: rent-detail and sale-detail take an id.
  • Agencies: agency takes a slug, with type (ahto or ahst).
  • Places: autocomplete takes a keyword, with type (city or station) and prefecture; places takes a query.

The recorded rent-search (prefecture=tokyo, city=shinjuku, layouts=1LDK, per_page=2, rent_max=200000) returns listings, each with id, url, title, rent_yen, management_fee_yen, deposit, key_money, layout, area_m2, floor, room_number, image_count, is_new, agency and building (with address, type, age_years, access and stations). Its pagination gives total_listings (2,478), total_buildings (554), total_pages and has_next_page, because results come grouped by building.

How a call works

Search 1LDK rentals in Shinjuku: GET /v1/athome/rent-search?prefecture=tokyo&city=shinjuku&layouts=1LDK&per_page=2&rent_max=200000 with your key in the X-API-Key header. Each listing's id goes to rent-detail, and its agency.slug (such as ahto/tkhome) goes to agency. Every successful call costs 1 credit; failed calls cost nothing.

Real estateJSONRESTMCP

More real estate APIs

28Hse4zida59199.co99acresAdondevivirApartment ListApartments.comAqarAqarmapArgenpropBatdongsan.com.vn

Use cases

Track rents in yen by layout, such as 1K or 1LDK, across Tokyo wards

Use the athome API to track rents in yen by layout, such as 1K or 1LDK, across Tokyo wards

Compare management fees, deposit and key money between buildings

Use the athome API to compare management fees, deposit and key money between buildings

Filter by walking time to a station with `walk_max`

Use the athome API to filter by walking time to a station with `walk_max`

Screen homes for sale by building age with `age_max`

Use the athome API to screen homes for sale by building age with `age_max`

FAQ

Questions

Do I need an athome account?

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

How much does the athome 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.

Which prefectures does it cover?

All 47. Pass `prefecture` by its romanised name, such as tokyo, osaka or hokkaido; `rent-search` and `sale-search` require it.

Should I build an athome scraper instead?

You can, but an athome scraper is code you maintain: page changes break it, requests get blocked, and athome's terms govern how you collect data. The athome API gives you 7 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 athome API with 100 free credits

No credit card. Failed calls are never billed.

Get a free API keyRead the docs