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

LIFULL HOME'S Autocomplete API

GET https://scrappa.co/api/lifull-homes/autocomplete

Suggest place and station names for a typed text (Japanese). The site returns labels only, so each suggestion has a `label` and a `type` read from the label: `station`, `city`, `prefecture` or `keyword`. Use the areas endpoint to turn a city label into the slug the searches need. An unknown text returns an empty list.

LIFULL HOME'S Autocomplete API 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/lifull-homes/autocomplete
Auth header
x-api-key
Cost
1 credit/request
query = coffee shops
Response preview
200 OK
{
    "data": {
        "query": "\u65b0\u5bbf",
        "suggestions": [
            {
                "type": "city",
                "label": "\u65b0\u5bbf\u533a"
            },
            {
                "type": "station",
                "label": "\u65b0\u5bbf\u4e09\u4e01\u76ee\u99c5"
            },
            {
                "type": "station",
...

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.

query string Required

Place or station name in Japanese, e.g. 新宿. Up to 60 characters.

Example value coffee shops

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": {
        "query": "\u65b0\u5bbf",
        "suggestions": [
            {
                "type": "city",
                "label": "\u65b0\u5bbf\u533a"
            },
            {
                "type": "station",
                "label": "\u65b0\u5bbf\u4e09\u4e01\u76ee\u99c5"
            },
            {
                "type": "station",
                "label": "\u65b0\u5bbf\u99c5"
            }
        ]
    },
    "meta": {
        "billable": true,
        "endpoint_family": "autocomplete"
    },
    "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.