# LIFULL HOME'S Autocomplete API

<p>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.</p>

- **Documentation:** [https://scrappa.co/docs/lifull-homes-api/lifull_homes_autocomplete](https://scrappa.co/docs/lifull-homes-api/lifull_homes_autocomplete)
- **API group:** LIFULL HOME'S API
- **Endpoint:** `GET https://scrappa.co/api/lifull-homes/autocomplete`

## 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 |
| --- | --- | --- | --- |
| `query` | string | Yes | Place or station name in Japanese, e.g. `新宿`. Up to 60 characters. |

## Example response

```json
{
    "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

| 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)