--- title: "athome API: JSON data, 7 endpoints, 1 credit per call" description: "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." url: https://perceptlayer.com/apis/athome --- [APIs](https://perceptlayer.com/apis) / [Real estate](https://perceptlayer.com/verticals/real-estate) / athome 1 credit per call 7 endpoints 21 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 key](https://perceptlayer.com/signup) Run 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 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. | # | id string | url url | title string | rent\_yen integer | rent\_man\_yen string | management\_fee\_yen integer | management\_fee\_text string | deposit string | no\_deposit boolean | key\_money string | no\_key\_money boolean | layout string | area\_m2 number | floor integer | room\_number string | thumbnail url | image\_count integer | is\_new boolean | has\_panorama boolean | agency object | building object | | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | 1 | 6992715114 | https://www.athome.co.jp/chintai/6992715114/ | コンフォリア西早稲田 1103 1LDK | 189000 | 18.9 | 10000 | 10,000円 | 1ヶ月 | false | なし | true | 1LDK | 35.79 | 11 | 1103 | https://www.athome.co.jp/image\_files/path/\_VmYwyI9UxeMju4b3VDwdA==.jpeg | 16 | false | true | {4 fields} | {10 fields} | | 2 | 1107607033 | https://www.athome.co.jp/chintai/1107607033/ | コンフォリア西早稲田 11階 1LDK | 189000 | 18.9 | 10000 | 10,000円 | 1ヶ月 | false | なし | true | 1LDK | 35.79 | 11 | — | https://www.athome.co.jp/image\_files/path/ItEK\_eU9wFHfN4GEtjB7SA==.jpeg | 24 | false | true | {4 fields} | {10 fields} | | 3 | 6992504848 | https://www.athome.co.jp/chintai/6992504848/ | コンフォリア西早稲田 1204 1LDK | 200000 | 20 | 10000 | 10,000円 | 1ヶ月 | false | なし | true | 1LDK | 37.61 | 12 | 1204 | https://www.athome.co.jp/image\_files/path/rFzQ107SUu-tvotf\_nmd7A==.jpeg | 16 | false | true | {4 fields} | {10 fields} | Recorded from our API · 3 items shown · 21 datapoints per item GET /v1/athome/rent-search?prefecture=tokyo&city=shinjuku&layouts=1LDK&per\_page=2&rent\_max=200000 21 datapoints ### Identity - id string - title string ### Contact - url url ### Location - area\_m2 number ### Reputation - image\_count integer ### Price - management\_fee\_yen integer - management\_fee\_text string ### Other - rent\_yen integer - rent\_man\_yen string - deposit string - no\_deposit boolean - key\_money string - no\_key\_money boolean - layout string - floor integer - room\_number string - thumbnail url - is\_new boolean - has\_panorama boolean - agency object - building object Playground ## Run this API cURL shell ``` 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. | Endpoint | Required parameters | Cost | | --- | --- | --- | | [GET `/v1/athome/agency`](https://perceptlayer.com/apis/athome/agency) | `slug` +1 optional | 1 credit | | [GET `/v1/athome/autocomplete`](https://perceptlayer.com/apis/athome/autocomplete) | `keyword` +2 optional | 1 credit | | [GET `/v1/athome/places`](https://perceptlayer.com/apis/athome/places) | `query` | 1 credit | | [GET `/v1/athome/rent-detail`](https://perceptlayer.com/apis/athome/rent-detail) | `id` | 1 credit | | [GET `/v1/athome/rent-search`](https://perceptlayer.com/apis/athome/rent-search) | `prefecture` +10 optional | 1 credit | | [GET `/v1/athome/sale-detail`](https://perceptlayer.com/apis/athome/sale-detail) | `id` | 1 credit | | [GET `/v1/athome/sale-search`](https://perceptlayer.com/apis/athome/sale-search) | `prefecture` +10 optional | 1 credit | Overview ## About the athome API ## 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 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) [Batdongsan.com.vn](https://perceptlayer.com/apis/batdongsan) 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 key](https://perceptlayer.com/signup) [Read the docs](https://docs.perceptlayer.com)