at home Rent Search API Documentation Search rental rooms on at home (athome.co.jp), the Japanese real estate portal, by prefecture and city. Filter by property type, rent range, layout, floor area, walk time to the station and building age. Each listing is one room with id, detail url, rent, management fee, deposit, key money, layout, area, floor, photo count, the selling agency and the building around it: name, address, type, floors, age, station access and photos. Pagination counts buildings and returns total listings and total buildings. Every returned room 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. Room coordinates come with the detail route, not with the list.
Run this endpoint
Endpoint
Parameters
Start with the required fields, then add optional filters only when your use case needs them.
Runnable path
1 required parameter needed before sending a request.
10 optional filters available.
string
Required
Prefecture as a lower-case English name: tokyo, osaka, kanagawa, hokkaido and so on. All 47 prefectures work.
example
string
Optional
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.
example
string
Optional
apartment, mansion or house.
example
integer
Optional
Minimum monthly rent in yen. Allowed: 20000 to 200000 in steps of 5000, 210000 to 300000 in steps of 10000, then 350000, 400000, 500000, 700000 and 1000000. Other values give a 422 error that lists the allowed values.
10
integer
Optional
Maximum monthly rent in yen. Same allowed values as min rent.
10
integer
Optional
Minimum floor area in square metres: 20 to 100 in steps of 5.
10
integer
Optional
Maximum walking minutes to a station: 1, 3, 5, 7, 10, 15 or 20. The site applies it to any station of the building.
10
integer
Optional
Maximum building age in years: 0 (new), 3, 5, 10, 15, 20, 25, 30, 35 or 40.
10
string
Optional
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.
example
integer
Optional
Buildings per page, 1 to 50, default 30. A building can hold several rooms, so a page can return more listings than this number.
10
integer
Optional
Page number, 1-based. A page past the last page returns an empty list, never another page.
1
Response Schema
Example response fields are illustrative; inspect the JSON before integrating.
Example response fields
Scan these fields before integrating.
data
meta
success
{
"data": {
"filters": {
"city": "shinjuku",
"layouts": [
"1LDK"
],
"rent_max": 200000,
"prefecture": "tokyo"
},
"listings": [
{
"id": "6992484285",
"url": "https://www.athome.co.jp/chintai/6992484285/",
"floor": 5,
"title": "\u30ea\u30f4 \u30a2\u30f3 \u30d5\u30eb\u30fc\u30eb 502 1LDK",
"agency": {
"id": "023280",
"pr": "\u5730\u5143\u30fb\u9ad8\u7530\u99ac\u5834\u306b\u5bc6\u7740\u266a\u30b9\u30bf\u30c3\u30d5\u5168\u54e1\u5b85\u5efa\u514d\u8a31\u53d6\u5f97\u266a\u306a\u3093\u3067\u3082\u3054\u76f8\u8ac7\u304f\u3060\u3055\u3044\u266a",
"name": "TK\u30db\u30fc\u30e0(\u6709)\u6771\u548c\u4f01\u753b",
"slug": "ahto/tkhome"
},
"is_new": false,
"layout": "1LDK",
"area_m2": 30.95,
"deposit": "1\u30f6\u6708",
"building": {
"name": "\u30ea\u30f4 \u30a2\u30f3 \u30d5\u30eb\u30fc\u30eb 7\u968e\u5efa",
"type": "\u8cc3\u8cb8\u30de\u30f3\u30b7\u30e7\u30f3",
"built": "2026\u5e744\u6708",
"access": [
"\u6771\u4eac\u30e1\u30c8\u30ed\u6771\u897f\u7dda \u300c\u9ad8\u7530\u99ac\u5834\u300d\u99c5 \u5f92\u6b697\u5206"
],
"floors": "7\u968e\u5efa",
"images": [
{
"url": "https://www.athome.co.jp/image_files/path/0b3iF1t4nPNxDLEu332-pg==.jpeg",
"category": "\u5916\u89b3"
},
{
"url": "https://www.athome.co.jp/image_files/path/bELt5pZPmA-jgAtewfs-_A==.jpeg",
"category": "\u30ea\u30d3\u30f3\u30b0"
}
],
"address": "\u65b0\u5bbf\u533a\u4e0b\u843d\u54081\u4e01\u76ee",
"stations": [
{
"line": "\u6771\u4eac\u30e1\u30c8\u30ed\u6771\u897f\u7dda",
"station": "\u9ad8\u7530\u99ac\u5834",
"walk_minutes": 7
},
{
"line": "JR\u5c71\u624b\u7dda",
"station": "\u9ad8\u7530\u99ac\u5834",
"walk_minutes": 7
},
{
"line": "\u897f\u6b66\u65b0\u5bbf\u7dda",
"station": "\u4e0b\u843d\u5408",
"walk_minutes": 8
}
],
"age_years": 0,
"room_count": 1
},
"rent_yen": 148000,
"key_money": "\u306a\u3057",
"thumbnail": "https://www.athome.co.jp/image_files/path/bELt5pZPmA9LBgl4up0a3w==.jpeg",
"no_deposit": false,
"image_count": 16,
"room_number": "502",
"has_panorama": true,
"no_key_money": true,
"rent_man_yen": "14.8",
"management_fee_yen": 10000,
"management_fee_text": "10,000\u5186"
},
{
"id": "1124229630",
"url": "https://www.athome.co.jp/chintai/1124229630/",
"floor": 7,
"title": "\u65b0\u5bbf\u533a \u897f\u65e9\u7a32\u75302\u4e01\u76ee(\u9ad8\u7530\u99ac\u5834\u99c5) 7\u968e 1LDK",
"agency": {
"id": "082898",
"pr": "\u6587\u4eac\u533a\u30fb\u5343\u4ee3\u7530\u533a\u30fb\u5fa1\u8336\u30ce\u6c34\u30fb\u672c\u90f7\u4e09\u4e01\u76ee\u8fd1\u8fba\u306e\u4e0d\u52d5\u7523\u8cc3\u8cb8\u306f\u5f53\u793e\u306b\u304a\u4efb\u305b\u4e0b\u3055\u3044!",
"name": "\u5fa1\u8336\u30ce\u6c34\u4e0d\u52d5\u7523\u30b9\u30fc\u30da\u30ea\u30a2\u30db\u30fc\u30e0 \u30b9\u30fc\u30da\u30ea\u30a2\u30b9(\u682a)",
"slug": "ahto/superios"
},
"is_new": false,
"layout": "1LDK",
"area_m2": 43.62,
"deposit": "18.5\u4e07\u5186",
"building": {
"name": "\u65b0\u5bbf\u533a \u897f\u65e9\u7a32\u75302\u4e01\u76ee(\u9ad8\u7530\u99ac\u5834\u99c5) \u5730\u4e0a14\u968e\u5730\u4e0b1\u968e\u5efa",
"type": "\u8cc3\u8cb8\u30de\u30f3\u30b7\u30e7\u30f3",
"built": "2007\u5e743\u6708(\u7bc919\u5e748\u30f6\u6708)",
"access": [
"JR\u5c71\u624b\u7dda \u300c\u9ad8\u7530\u99ac\u5834\u300d\u99c5 \u5f92\u6b698\u5206"
],
"floors": "\u5730\u4e0a14\u968e\u5730\u4e0b1\u968e\u5efa",
"images": [
{
"url": "https://www.athome.co.jp/image_files/path/rAdwdgAP08M2s3xu-3clXA==.jpeg",
"category": "\u5916\u89b3"
},
{
"url": "https://www.athome.co.jp/image_files/path/iH1lXbt7_5n2rwQRXSJpvw==.jpeg",
"category": "\u30ea\u30d3\u30f3\u30b0"
}
],
"address": "\u65b0\u5bbf\u533a\u897f\u65e9\u7a32\u75302\u4e01\u76ee",
"stations": [
{
"line": "JR\u5c71\u624b\u7dda",
"station": "\u9ad8\u7530\u99ac\u5834",
"walk_minutes": 8
},
{
"line": "\u6771\u4eac\u30e1\u30c8\u30ed\u526f\u90fd\u5fc3\u7dda",
"station": "\u897f\u65e9\u7a32\u7530",
"walk_minutes": 2
},
{
"line": "\u6771\u4eac\u30e1\u30c8\u30ed\u6771\u897f\u7dda",
"station": "\u65e9\u7a32\u7530",
"walk_minutes": 17
}
],
"age_years": 19,
"room_count": 1
},
"rent_yen": 185000,
"key_money": "18.5\u4e07\u5186",
"no_deposit": false,
"image_count": 14,
"no_key_money": false,
"rent_man_yen": "18.5",
"management_fee_yen": 10000,
"management_fee_text": "10,000\u5186"
}
],
"pagination": {
"page": 1,
"per_page": 2,
"total_pages": 268,
"has_next_page": true,
"total_listings": 2071,
"total_buildings": 536,
"buildings_on_page": 2
}
},
"meta": {
"billable": true,
"endpoint_family": "rent_search"
},
"success": true
}Errors
Handle these documented responses before retrying or showing customer-facing failures.
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.
{
"errors": {
"rent_min": [
"The rent min must be one of: 20000, 25000, 30000."
]
},
"message": "The rent min must be one of: 20000, 25000, 30000."
}Not Found
The listing or agency does not exist or is no longer online. This response is not billable.
{
"meta": {
"billable": false,
"retryable": false,
"endpoint_family": "rent_detail"
},
"error": {
"code": "NOT_FOUND",
"message": "The requested at home record was not found."
},
"success": false
}Bad Gateway
The site answered with a shape this API does not know. This response is not billable.
{
"meta": {
"billable": false,
"retryable": true,
"endpoint_family": "rent_search"
},
"error": {
"code": "PARSER_DRIFT",
"message": "at home returned an unexpected response."
},
"success": false
}Service Unavailable
at home could not be reached or blocked the request, also after one retry. Retry later. This response is not billable.
{
"meta": {
"billable": false,
"retryable": true,
"endpoint_family": "rent_search"
},
"error": {
"code": "UPSTREAM_UNAVAILABLE",
"message": "The at home service is temporarily unavailable. Please retry."
},
"success": false
}Generate Code with AI
Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.
Try It Live
Test this endpoint in our interactive playground with real data.