ParuVendu Immobilier Place Autocomplete API 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 search_slug that the search route takes as place.
Notes: Accents are removed for you, because the source finds nothing for accented text. An empty places list is a valid, billable answer. The coordinates belong to the commune and are not the position of a listing.
Run this endpoint
Endpoint
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.
string
Required
Place name or postcode, 2 to 100 characters. Example: lyon.
coffee shops
Response Schema
Example response fields are illustrative; inspect the JSON before integrating.
Example response fields
Scan these fields before integrating.
data
success
{
"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
Handle these documented responses before retrying or showing customer-facing failures.
Validation Error
A required parameter or a value is invalid. This response is not billable.
{
"errors": {
"field": [
"The field is invalid."
]
},
"message": "The request validation failed"
}Upstream Unavailable
ParuVendu Immobilier could not be reached. This response is not billable and is retryable.
{
"meta": {
"billable": false,
"retryable": true,
"endpoint_family": "autocomplete"
},
"error": {
"code": "UPSTREAM_UNAVAILABLE",
"message": "ParuVendu Immobilier could not be reached. Please retry shortly."
},
"success": false
}Unexpected Upstream Data
ParuVendu Immobilier returned data in an unexpected shape. This response is not billable and is retryable.
{
"meta": {
"billable": false,
"retryable": true,
"endpoint_family": "autocomplete"
},
"error": {
"code": "INVALID_UPSTREAM_SHAPE",
"message": "ParuVendu Immobilier returned data in an unexpected shape. Please retry shortly."
},
"success": false
}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.