Logic-Immo Autocomplete API turns a city name into place ids. Every candidate is returned with its id (the place_id for search), label, level, postal codes, coordinates and parents. The API never picks one for you: Gironde returns towns that end in -sur-Gironde, and a postal code returns the matching city first. Cities and towns are covered. Departments, regions, streets and neighborhoods return an empty list, which is a valid, billed answer.
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.
1 optional filter available.
string
Required
City name or postal code, 2 to 100 characters. Example: lyon.
coffee shops
integer
Optional
Number of candidates, 1 to 20, default 10.
10
Response Schema
Example response fields are illustrative; inspect the JSON before integrating.
Example response fields
Scan these fields before integrating.
data
meta
success
{
"data": {
"count": 6,
"query": "lyon",
"results": [
{
"id": "AD08FR28808",
"label": "Lyon (69)",
"labels": [
"Lyon (69)"
],
"parents": [],
"type_key": "AD08",
"coordinates": {
"latitude": 45.7549164389887,
"longitude": 4.836341894211525
},
"postal_codes": [
"69000",
"69001"
]
},
{
"id": "AD08FR10263",
"label": "Lyons-la-For\u00eat (27480)",
"labels": [
"Lyons-la-For\u00eat (27480)"
],
"parents": [],
"type_key": "AD08",
"coordinates": {
"latitude": 49.3940045119265,
"longitude": 1.47312861430222
},
"postal_codes": [
"27480"
]
}
]
},
"meta": {
"billable": true,
"endpoint_family": "autocomplete"
},
"success": true
}Errors
Handle these documented responses before retrying or showing customer-facing failures.
Validation Error
The text is missing, shorter than 2 characters, or the limit is out of range. This response is not billable.
{
"errors": {
"q": [
"The q field is required."
]
},
"message": "The request validation failed"
}Upstream Unavailable
Logic-Immo could not be reached, or returned data that does not match the expected shape. Retry shortly. This response is not billable.
{
"meta": {
"billable": false,
"retryable": true,
"endpoint_family": "autocomplete"
},
"error": {
"code": "UPSTREAM_UNAVAILABLE",
"message": "Logic-Immo could not be reached. 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.