# Leboncoin Immobilier Locations

Autocomplete French cities, departments and regions. Feed a returned label into the location parameter of the search endpoint.

- **Documentation:** [https://scrappa.co/docs/leboncoin-immo-api/leboncoin_immo_locations](https://scrappa.co/docs/leboncoin-immo-api/leboncoin_immo_locations)
- **API group:** Leboncoin Immobilier API
- **Endpoint:** `GET https://scrappa.co/api/leboncoin-immo/locations`

## 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 |
| --- | --- | --- | --- |
| `q` | string | Yes | Partial place name, for example Paris. |

## Example request

```bash
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/leboncoin-immo/locations?q=Paris"
```

## Example response

```json
{
    "success": true,
    "data": {
        "suggestions": [
            {
                "locationType": "city",
                "label": "Lyon (69003)",
                "city": "Lyon",
                "zipcode": "69003"
            }
        ],
        "total": 1
    },
    "meta": {
        "endpoint_family": "locations",
        "billable": true
    }
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 404 | Not Found | The requested property listing was not found. This response is not billable. |
| 422 | Validation Error | A public parameter is invalid. This response is not billable. |
| 503 | Service Unavailable | The service could not obtain a complete result. 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)