# at home Sale Search API Documentation

at home Sale Search API Documentation Search used condominiums for sale on at home (athome.co.jp) by prefecture and city. Filter by price range, layout, floor area, walk time to the station and building age. Each listing has id, detail url, price, price per tsubo, layout, area, floor, address, building age and structure, station access, land rights, photos and the selling agency. Other property types (new condominiums, houses, land) are not part of this route yet. Every returned listing is checked against the requested filters. Prices are returned in yen next to the original man-yen text. The site has no bathrooms filter, so none is offered. The list uses the default order of the site, which mixes sponsored slots, so the order can change between calls and results are not cached.

- **Documentation:** [https://scrappa.co/docs/athome-jp-api/athome_jp_sale_search](https://scrappa.co/docs/athome-jp-api/athome_jp_sale_search) - **API group:** at home Japan API - **Endpoint:** `GET https://scrappa.co/api/athome-jp/sale/search` ## Authentication Send your Scrappa API key in the `X-API-KEY` request header. Paid endpoints also support accountless x402 payments when called without an API key. ## Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | `prefecture` | string | Yes | Prefecture as a lower-case English name: tokyo, osaka, kanagawa, hokkaido and so on. All 47 prefectures work. | | `city` | string | No | One or more city values from the autocomplete route (for example shinjuku), separated by commas, at most 10. Omit for the whole prefecture. An unknown city gives a 422 error. | | `price_min` | integer | No | Minimum price in yen. Allowed: 5000000 to 70000000 in steps of 5000000, 80000000, 90000000, 100000000 to 200000000 in steps of 10000000, then 250000000, 300000000, 350000000 and 400000000. | | `price_max` | integer | No | Maximum price in yen. Same allowed values as min price. | | `area_min` | integer | No | Minimum floor area in square metres: 20 to 100 in steps of 5, then 120 and 150. | | `area_max` | integer | No | Maximum floor area in square metres. Same allowed values as min area. | | `walk_max` | integer | No | Maximum walking minutes to a station: 1, 3, 5, 7, 10, 15 or 20. The site applies it to any station of the building. | | `age_max` | integer | No | Maximum building age in years: 0 (new), 3, 5, 10, 15, 20, 25, 30, 35 or 40. | | `layouts` | string | No | Layouts separated by commas: 1R, 1K, 1DK, 1LDK, 2K, 2DK, 2LDK, 3K, 3DK, 3LDK, 4K, 4DK, 4LDK. 4LDK also covers larger layouts. This is the bedroom filter of the site: the site has no separate bedrooms filter. | | `per_page` | integer | No | Listings per page, 1 to 50, default 30. | | `page` | integer | No | Page number, 1-based. A page past the last page returns an empty list, never another page. | ## Example response ```json { "data": { "filters": { "city": "shinjuku", "price_max": 50000000, "prefecture": "tokyo" }, "listings": [ { "id": "6990704216", "pr": "\u4f1a\u793e\u6982\u8981 \u5171\u6709\u90e8\u5206\u306e\u7ba1\u7406\u304b\u3089\u8cc7\u7523\u306e\u7ba1\u7406\u30fb\u904b\u7528\u30fb\u58f2\u5374\u307e\u3067\u304a\u4efb\u305b\u304f\u3060\u3055\u3044\u3002", "url": "https://www.athome.co.jp/mansion/6990704216/", "built": "1988\u5e748\u6708(\u7bc938\u5e743\u30f6\u6708)", "floor": 3, "title": "\u65e5\u8208\u30d1\u30ec\u30b9\u65b0\u5bbfPART\u2162 3\u968e \u30ef\u30f3\u30eb\u30fc\u30e0", "yield": "8.48%", "access": [ "\u90fd\u55b6\u5927\u6c5f\u6238\u7dda \u300c\u843d\u5408\u5357\u9577\u5d0e\u300d\u99c5 \u5f92\u6b697\u5206", "\u897f\u6b66\u65b0\u5bbf\u7dda \u300c\u65b0\u4e95\u85ac\u5e2b\u524d\u300d\u99c5 \u5f92\u6b6913\u5206" ], "agency": { "name": "\u8208\u548c\u7ba1\u7406(\u682a)", "access": "\u6771\u4eac\u30e1\u30c8\u30ed\u5343\u4ee3\u7530\u7dda/\u8d64\u5742 \u5f92\u6b692\u5206" }, "images": [ { "url": "https://www.athome.co.jp/image_files/path/Q6X9_QjxyUhSNfBALfNX2Q==.jpeg", "category": "not_set" }, { "url": "https://www.athome.co.jp/image_files/path/rbu-r_axPdZbF8dR7X1k1A==.jpeg", "category": "layout" } ], "layout": "1R", "address": "\u65b0\u5bbf\u533a\u897f\u843d\u54081\u4e01\u76ee", "area_m2": 16.5, "age_years": 38, "price_yen": 7500000, "structure": "\uff32\uff23", "area_tsubo": "4.99\u576a", "floors_text": "4\u968e\u5efa / 3\u968e", "land_rights": "\u6240\u6709\u6a29", "is_new_build": false, "price_man_yen": "750", "property_type": "\u4e2d\u53e4\u30de\u30f3\u30b7\u30e7\u30f3", "price_per_tsubo": "150.27\u4e07\u5186" }, { "id": "1131740408", "pr": "\u4e2d\u53e4\u6295\u8cc7\u7528\u30de\u30f3\u30b7\u30e7\u30f3\u306a\u3089\u304a\u4efb\u305b\u4e0b\u3055\u3044\uff01\u7d4c\u9a13\u3068\u5b9f\u7e3e\u304c\u9055\u3044\u307e\u3059\uff01", "url": "https://www.athome.co.jp/mansion/1131740408/", "built": "1964\u5e741\u6708(\u7bc962\u5e7410\u30f6\u6708)", "floor": 5, "title": "\u65b0\u5bbf\u30b3\u30fc\u30dd2\u53f7\u9928 5\u968e \u30ef\u30f3\u30eb\u30fc\u30e0", "yield": "10.00%", "access": [ "\u6771\u4eac\u30e1\u30c8\u30ed\u526f\u90fd\u5fc3\u7dda \u300c\u6771\u65b0\u5bbf\u300d\u99c5 \u5f92\u6b694\u5206", "\u90fd\u55b6\u5927\u6c5f\u6238\u7dda \u300c\u6771\u65b0\u5bbf\u300d\u99c5 \u5f92\u6b694\u5206" ], "agency": { "name": "(\u682a)\u30e9\u30f3\u30c9\u30cd\u30c3\u30c8 \u5927\u962a\u652f\u5e97", "access": "\u5730\u4e0b\u9244\u5fa1\u5802\u7b4b\u7dda/\u6885\u7530 \u5f92\u6b699\u5206" }, "images": [ { "url": "https://www.athome.co.jp/image_files/path/uW6SyCsEGKfTUUQ0Qpe4Ug==.jpeg", "category": "appearance" }, { "url": "https://www.athome.co.jp/image_files/path/CPg60TC_ZL9AifrvXTphnw==.jpeg", "category": "layout" } ], "layout": "1R", "address": "\u65b0\u5bbf\u533a\u65b0\u5bbf7\u4e01\u76ee", "area_m2": 20.52, "age_years": 62, "price_yen": 7800000, "structure": "\uff32\uff23", "area_tsubo": "6.20\u576a", "floors_text": "5\u968e\u5efa / 5\u968e", "land_rights": "\u65e7\u6cd5\u5730\u4e0a\u6a29", "is_new_build": false, "price_man_yen": "780", "property_type": "\u4e2d\u53e4\u30de\u30f3\u30b7\u30e7\u30f3", "price_per_tsubo": "125.66\u4e07\u5186" } ], "pagination": { "page": 1, "per_page": 2, "total_pages": 331, "has_next_page": true, "total_listings": 661 } }, "meta": { "billable": true, "endpoint_family": "sale_search" }, "success": true } ``` ## Errors | Status | Error | Description | | --- | --- | --- | | 422 | Validation Error | A query parameter is missing or invalid, or the site does not know the city. No upstream request is made for a missing parameter. This response is not billable. | | 404 | Not Found | The listing or agency does not exist or is no longer online. This response is not billable. | | 502 | Bad Gateway | The site answered with a shape this API does not know. This response is not billable. | | 503 | Service Unavailable | at home could not be reached or blocked the request, also after one retry. Retry later. This response is not billable. | ## More Scrappa resources - [API documentation](https://scrappa.co/docs) - [Full LLM-readable API reference](https://scrappa.co/llms-full.txt) - [OpenAPI specification](https://scrappa.co/docs/api.json) - [Pricing](https://scrappa.co/pricing)