# LIFULL HOME'S Areas API

<p>List the cities and wards of a prefecture with the `slug` the rent and sale searches take as `city`, the Japanese name and the average rent. Use `query` to find the slug of a place label, e.g. 新宿 gives `shinjuku-city`.</p>

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

## 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). |
| `query` | string | No | Optional name filter, e.g. `新宿`. |

## Example response

```json
{
    "data": {
        "cities": [
            {
                "name": "\u65b0\u5bbf\u533a",
                "slug": "shinjuku-city",
                "average_rent_yen": 137700,
                "average_rent_text": "13.77\u4e07\u5186"
            }
        ],
        "prefecture": "tokyo",
        "prefecture_name": "\u6771\u4eac\u90fd"
    },
    "meta": {
        "billable": true,
        "endpoint_family": "areas"
    },
    "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)