Skip to content
Scrappa Get API key
LIFULL HOME'S API 1 credit/request

LIFULL HOME'S Rent Search API

GET https://scrappa.co/api/lifull-homes/rent/search

Search rental rooms (賃貸) on LIFULL HOME'S by prefecture and city. Filter by rent, area, layout, walk time and building age, and sort by rent, area, building age, address or newest. Each listing is one room with its building. Numbers sit next to the Japanese text: `rent_yen`, `admin_fee_yen`, `deposit_yen`, `key_money_yen`, `area_m2`, `age_years` and `walk_min`. The search form takes bounds in steps, so every bound is checked again on the parsed values: a returned room never breaks a filter, and `filtered_out` counts the rooms removed from the page. The walk time filter uses the nearest station. `pagination.total_results` is the number of buildings the site counts for the form steps, `total_rooms` the number of rooms. 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.

LIFULL HOME'S Rent Search API 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/lifull-homes/rent/search
Auth header
x-api-key
Cost
1 credit/request
prefecture = example
Response preview
200 OK
{
    "data": {
        "filters": {
            "city": "shinjuku-city",
            "rent_max": 120000,
            "prefecture": "tokyo"
        },
        "listings": [
            {
                "id": "d0cc9318dd559c1a2913a5358ded971639a8d0ab",
                "floor": "2\u968e",
                "layout": "\u30ef\u30f3\u30eb\u30fc\u30e0",
                "address": "\u6771\u4eac\u90fd\u65b0\u5bbf\u533a\u5317\u65b0\u5bbf3\u4e01\u76ee7-4",
                "area_m2": 10.12,
...

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.

prefecture string Required

Prefecture as a lower-case English name: tokyo, osaka, kanagawa, hokkaido and so on (all 47).

Example value example
city string Optional

City or ward slug from the areas endpoint, e.g. shinjuku-city. Omit for the whole prefecture. An unknown slug answers 404.

Example value example
rent_min integer Optional

Minimum monthly rent in yen, without the management fee.

Example value 10
rent_max integer Optional

Maximum monthly rent in yen, without the management fee. Must not be below rent_min.

Example value 10
area_min number Optional

Minimum floor area in square meters.

Example value 10
area_max number Optional

Maximum floor area in square meters. Must not be below area_min.

Example value 10
walk_max integer Optional

Maximum walking minutes to the nearest station: 1, 5, 7, 10, 15 or 20.

Example value 10
age_max integer Optional

Maximum building age in years, 0 to 30 (0 means new).

Example value 10
layouts string Optional

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.

Example value example
sort string Optional

recommended (default), price_asc, price_desc (rent), area_desc, built_newest, address or newest.

Example value relevance
page integer Optional

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 value 1

Response Schema

Example response fields are illustrative; inspect the JSON before integrating.

Example response fields

Scan these fields before integrating.

data meta success
JSON Response
200 OK
{
    "data": {
        "filters": {
            "city": "shinjuku-city",
            "rent_max": 120000,
            "prefecture": "tokyo"
        },
        "listings": [
            {
                "id": "d0cc9318dd559c1a2913a5358ded971639a8d0ab",
                "floor": "2\u968e",
                "layout": "\u30ef\u30f3\u30eb\u30fc\u30e0",
                "address": "\u6771\u4eac\u90fd\u65b0\u5bbf\u533a\u5317\u65b0\u5bbf3\u4e01\u76ee7-4",
                "area_m2": 10.12,
                "move_in": "\u5373\u5165\u5c45\u53ef",
                "age_text": "1\u5e74",
                "features": [
                    "\u30d5\u30ed\u30fc\u30ea\u30f3\u30b0",
                    "\u89d2\u90e8\u5c4b",
                    "\u30aa\u30fc\u30c8\u30ed\u30c3\u30af",
                    "\u30a8\u30a2\u30b3\u30f3"
                ],
                "rent_yen": 78000,
                "stations": [
                    {
                        "raw": "JR\u7dcf\u6b66\u7dda \u5927\u4e45\u4fdd\u99c5 \u5f92\u6b697\u5206",
                        "line": "JR\u7dcf\u6b66\u7dda",
                        "station": "\u5927\u4e45\u4fdd",
                        "walk_min": 7
                    },
                    {
                        "raw": "JR\u5c71\u624b\u7dda \u65b0\u5927\u4e45\u4fdd\u99c5 \u5f92\u6b6911\u5206",
                        "line": "JR\u5c71\u624b\u7dda",
                        "station": "\u65b0\u5927\u4e45\u4fdd",
                        "walk_min": 11
                    },
                    {
                        "raw": "\u90fd\u55b6\u5927\u6c5f\u6238\u7dda \u6771\u4e2d\u91ce\u99c5 \u5f92\u6b6913\u5206",
                        "line": "\u90fd\u55b6\u5927\u6c5f\u6238\u7dda",
                        "station": "\u6771\u4e2d\u91ce",
                        "walk_min": 13
                    }
                ],
                "age_years": 1,
                "area_text": "10.12m\u00b2",
                "rent_text": "7.8\u4e07\u5186",
                "thumbnail": "https://image2.homes.jp/smallimg/image.php?file=http%3A%2F%2Fimg.homes.jp%2F113824%2Frent%2F18633%2F2%2F1%2F7ued.jpg",
                "source_url": "https://www.homes.co.jp/chintai/room/d0cc9318dd559c1a2913a5358ded971639a8d0ab/",
                "agency_name": "\u682a\u5f0f\u4f1a\u793e\u30ec\u30f3\u30bf\u30eb",
                "building_id": "1138240018633",
                "catchphrase": "\u3010\u65b0\u7bc9\u3011\u65b0\u751f\u6d3b\u5fdc\u63f4\u30ad\u30e3\u30f3\u30da\u30fc\u30f3\u2605\u6577\u91d10\u793c\u91d10\u4ef2\u4ecb\u65990\uff01",
                "deposit_yen": 0,
                "floors_text": "2\u968e\u5efa",
                "room_number": "201",
                "deposit_text": "\u7121",
                "floors_above": 2,
                "admin_fee_yen": 3000,
                "building_name": "\u30c6\u30a3\u30fb\u30a2\u30fc\u30e2\u30de\u30fc\u30e1\u30a4\u30c9",
                "building_type": "\u8cc3\u8cb8\u30a2\u30d1\u30fc\u30c8",
                "key_money_yen": 0,
                "admin_fee_text": "3,000\u5186",
                "deposit_months": 0,
                "key_money_text": "\u7121",
                "floor_plan_image": "https://image2.homes.jp/smallimg/image.php?file=http%3A%2F%2Fimg.homes.jp%2F113824%2Frent%2F18633%2F1%2F2%2Fbujm.jpg",
                "key_money_months": 0
            }
        ],
        "pagination": {
            "page": 1,
            "last_page": 124,
            "has_next_page": true,
            "total_results": 11398,
            "buildings_on_page": 30
        },
        "total_rooms": 51795
    },
    "meta": {
        "billable": true,
        "endpoint_family": "rent_search"
    },
    "success": true
}

Errors

Handle these documented responses before retrying or showing customer-facing failures.

404

HTTP 404

The listing, agency, area or page does not exist (a page after pagination.last_page also answers 404). This response is not billable.

422

HTTP 422

A parameter or filter is missing, invalid or not available for the property type. This response is not billable.

503

HTTP 503

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.

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.