# LIFULL HOME'S Sale Search API

<p>Search properties for sale (売買) on LIFULL HOME'S: used and new mansions, used and new houses and land, by prefecture and city. Filter by price, area, land area, layout, walk time and building age, and sort by price, area, building age, address or newest. Each listing is one unit or house; a new-build project is one listing with a price range (`price_yen` to `price_max_yen`). Numbers sit next to the Japanese text: `price_yen`, `area_m2`, `land_area_m2`, `age_years`, `built_month` and `walk_min`; `details` holds every printed label. Bounds are checked again on the parsed values, so a returned listing never breaks a filter (`filtered_out` counts the removed ones); a project passes a price filter when its range overlaps. Land has no area, age or layout filter, new builds have no age filter: those answer 422. LIFULL HOME'S has no bathroom filter, so there is none here. Japanese text is returned as published, next to parsed numbers. Telephone numbers of listings are not returned.</p>

- **Documentation:** [https://scrappa.co/docs/lifull-homes-api/lifull_homes_sale_search](https://scrappa.co/docs/lifull-homes-api/lifull_homes_sale_search)
- **API group:** LIFULL HOME'S API
- **Endpoint:** `GET https://scrappa.co/api/lifull-homes/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). |
| `property_type` | string | No | `used_mansion` (default), `new_mansion`, `used_house`, `new_house` or `land`. |
| `city` | string | No | City or ward slug from the areas endpoint, e.g. `shinjuku-city`. Omit for the whole prefecture. An unknown slug answers 404. |
| `price_min` | integer | No | Minimum price in yen. |
| `price_max` | integer | No | Maximum price in yen. Must not be below price_min. |
| `area_min` | number | No | Minimum floor area (mansion) or building area (house) in square meters. Not for land. |
| `area_max` | number | No | Maximum floor area (mansion) or building area (house) in square meters. Not for land. |
| `land_area_min` | number | No | Minimum land area in square meters. Houses and land only. |
| `land_area_max` | number | No | Maximum land area in square meters. Houses and land only. |
| `walk_max` | integer | No | Maximum walking minutes to the nearest station: 1, 5, 7, 10, 15 or 20. |
| `age_max` | integer | No | Maximum building age in years. Used mansion and used house only. |
| `layouts` | string | No | Layouts separated by commas: `1R`, `1K`, `1DK`, `1LDK`, `2K`, `2DK`, `2LDK`, `3K`, `3DK`, `3LDK`, `4K`, `4DK`, `4LDK+`. LIFULL HOME'S counts 1SLDK and similar with the plain layout. |
| `sort` | string | No | `recommended` (default), `price_asc`, `price_desc`, `area_desc`, `built_newest`, `address` or `newest`. Land has no area or built sort, new builds have no built sort. |
| `page` | integer | No | Page number, 1-based. Each page has up to 30 buildings or projects. `pagination.last_page` is the last page; a page after it answers 404 and is not billed. |

## Example response

```json
{
    "data": {
        "filters": {
            "city": "shinjuku-city",
            "price_max": 150000000,
            "prefecture": "tokyo",
            "property_type": "used_mansion"
        },
        "listings": [
            {
                "id": "1090830005111",
                "name": "\u30d1\u30fc\u30af\u30fb\u30b3\u30fc\u30c8\u56db\u8c37",
                "images": [
                    "https://image4.homes.jp/smallimg/image.php?file=http%3A%2F%2Fimg.homes.jp%2F109083%2Fsale%2F5111%2F2%2F3%2Fi1b0.jpg&width=208&height=138",
                    "https://image.homes.jp/smallimg/image.php?file=http%3A%2F%2Fimg.homes.jp%2F109083%2Fsale%2F5111%2F11%2F1%2Fe5by.jpg"
                ],
                "layout": "1SLDK",
                "address": "\u6771\u4eac\u90fd\u65b0\u5bbf\u533a\u5927\u4eac\u753a7-1",
                "area_m2": 52.26,
                "details": {
                    "\u4fa1\u683c": "12,990\u4e07\u5186",
                    "\u7dcf\u6238\u6570": "42\u6238",
                    "\u9593\u53d6\u308a": "1SLDK",
                    "\u5c02\u6709\u9762\u7a4d": "52.26m\u00b2",
                    "\u69cb\u9020/\u968e\u6570": "RC(\u9244\u7b4b\u30b3\u30f3\u30af\u30ea\u30fc\u30c8) / 5\u968e\u5efa",
                    "\u4e3b\u8981\u63a1\u5149\u9762": "\u6771",
                    "\u4ea4\u901a/\u6240\u5728\u5730": "\u6771\u4eac\u30e1\u30c8\u30ed\u4e38\u30ce\u5185\u7dda \u56db\u8c37\u4e09\u4e01\u76ee\u99c5 \u5f92\u6b695\u5206 \u6771\u4eac\u90fd\u65b0\u5bbf\u533a\u5927\u4eac\u753a7-1",
                    "\u7bc9\u5e74\u6708/\uff08\u7bc9\u5e74\u6570\uff09": "2002\u5e7412\u6708\uff08\u7bc924\u5e74\uff09"
                },
                "features": [
                    "\u30da\u30c3\u30c8\u76f8\u8ac7\u53ef"
                ],
                "stations": [
                    {
                        "raw": "\u6771\u4eac\u30e1\u30c8\u30ed\u4e38\u30ce\u5185\u7dda \u56db\u8c37\u4e09\u4e01\u76ee\u99c5 \u5f92\u6b695\u5206",
                        "line": "\u6771\u4eac\u30e1\u30c8\u30ed\u4e38\u30ce\u5185\u7dda",
                        "station": "\u56db\u8c37\u4e09\u4e01\u76ee",
                        "walk_min": 5
                    }
                ],
                "vertical": "mansion",
                "age_years": 24,
                "area_text": "52.26m\u00b2",
                "price_yen": 129900000,
                "structure": "RC(\u9244\u7b4b\u30b3\u30f3\u30af\u30ea\u30fc\u30c8) / 5\u968e\u5efa",
                "built_text": "2002\u5e7412\u6708\uff08\u7bc924\u5e74\uff09",
                "price_text": "12,990\u4e07\u5186",
                "source_url": "https://www.homes.co.jp/mansion/b-1090830005111/",
                "agency_name": "\u30b0\u30ed\u30fc\u30d0\u30eb\u30d9\u30a4\u30b9\u682a\u5f0f\u4f1a\u793e",
                "built_month": "2002-12",
                "catchphrase": "\u25c6\u5f53\u793e\u58f2\u4e3b\u25c6\u30fc\u7701\u30a8\u30cd\u57fa\u6e96\u9069\u5408\u4f4f\u5b85\u30fc\u65b0\u5bbf\u533a\u5927\u4eac\u753a \u7dd1\u306b\u6075\u307e\u308c\u305f\u9591\u9759\u306a\u4f4f\u74b0\u5883\u30fb\u4e09\u4e95\u4e0d\u52d5\u7523(\u682a)\u65e7\u5206\u8b72\u30d1\u30fc\u30af\u30fb\u30b3\u30fc\u30c8\u30b7\u30ea\u30fc\u30ba\u30fbLD\u306b\u5e8a\u6696\u623f\u30fb2014\u5e74\u5171\u7528\u90e8\u5927\u898f\u6a21\u4fee\u7e55\u2026",
                "image_count": 30,
                "orientation": "\u6771",
                "total_units": 42,
                "floors_above": 5,
                "property_label": "\u4e2d\u53e4\u30de\u30f3\u30b7\u30e7\u30f3"
            }
        ],
        "pagination": {
            "page": 1,
            "last_page": 25,
            "cards_on_page": 30,
            "has_next_page": true,
            "total_results": 1163
        }
    },
    "meta": {
        "billable": true,
        "endpoint_family": "sale_search"
    },
    "success": true
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
|  | The listing, agency, area or page does not exist (a page after pagination.last_page also answers 404). This response is not billable. |  |
|  | A parameter or filter is missing, invalid or not available for the property type. This response is not billable. |  |
|  | LIFULL HOME'S is temporarily unavailable or answered a page that no longer matches the documented contract. Retry the request. 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)
