# ParuVendu Immobilier Place Autocomplete API Documentation

<p><strong>ParuVendu Immobilier Place Autocomplete API</strong> returns the places that match a name or a postcode as JSON. Each place carries its label, category, postcode, all postcodes of the commune, INSEE code, commune coordinates and the <code>search_slug</code> that the search route takes as <code>place</code>.</p><p>Notes: Accents are removed for you, because the source finds nothing for accented text. An empty <code>places</code> list is a valid, billable answer. The coordinates belong to the commune and are not the position of a listing.</p>

- **Documentation:** [https://scrappa.co/docs/paruvendu-immo-api/paruvendu_immo_autocomplete](https://scrappa.co/docs/paruvendu-immo-api/paruvendu_immo_autocomplete)
- **API group:** ParuVendu Immobilier API
- **Endpoint:** `GET https://scrappa.co/api/paruvendu-immo/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 |
| --- | --- | --- | --- |
| `q` | string | Yes | Place name or postcode, 2 to 100 characters. Example: lyon. |

## Example response

```json
{
    "data": {
        "query": "lyon",
        "total": 12,
        "places": [
            {
                "name": "Lyon",
                "value": "Lyon",
                "category": "Communes",
                "latitude": 45.75782,
                "longitude": 4.835098,
                "insee_code": "69000",
                "postal_code": "69000",
                "search_slug": "lyon",
                "postal_codes": [
                    "69000",
                    "69001",
                    "69002",
                    "69003",
                    "69004",
                    "69005",
                    "69006",
                    "69007",
                    "69008",
                    "69009"
                ]
            },
            {
                "name": "Lyon",
                "value": "Lyon 1 (69001)",
                "category": "Communes",
                "latitude": 45.769653,
                "longitude": 4.826458,
                "insee_code": "69381",
                "postal_code": "69001",
                "search_slug": "lyon-69001",
                "postal_codes": [
                    "69001"
                ]
            }
        ]
    },
    "success": true
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 422 | Validation Error | A required parameter or a value is invalid. This response is not billable. |
| 503 | Upstream Unavailable | ParuVendu Immobilier could not be reached. This response is not billable and is retryable. |
| 503 | Unexpected Upstream Data | ParuVendu Immobilier returned data in an unexpected shape. This response is not billable and is retryable. |

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