Skip to main content
GET
/
public
/
location-autocomplete
curl --location -g --request GET 'https://api.stream.estate/public/location-autocomplete?query=paris' \
--header 'Content-Type: application/json'

{
  "hydra:member": [
    {
      "@id": "/cities/37087",
      "@type": "City",
      "code": "string",
      "displayName": "Lille (toute la ville)",
      "groupedCityNames": [
        "Capinghem",
        "Euralille",
        "Hellemmes lille",
        "Lezennes",
        "Lille",
        "Lomme"
      ],
      "groupedCityZipcodes": [
        "59000",
        "59160",
        "59260",
        "59777",
        "59800"
      ],
      "id": "37087",
      "insee": "59350",
      "libelle": "Lille",
      "location": {
        "lat": 50.629059,
        "lon": 3.06038
      },
      "name": "Lille",
      "zipcode": "59000"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.stream.estate/llms.txt

Use this file to discover all available pages before exploring further.

​
Query parameters

​
query
string
Query term to perform search.
​
excludedCitiesIds[]
array
Exclude cities using their IRI.
​
excludedDepartmentsIds[]
array
Exclude departments using their IRI.
curl --location -g --request GET 'https://api.stream.estate/public/location-autocomplete?query=paris' \
--header 'Content-Type: application/json'

{
  "hydra:member": [
    {
      "@id": "/cities/37087",
      "@type": "City",
      "code": "string",
      "displayName": "Lille (toute la ville)",
      "groupedCityNames": [
        "Capinghem",
        "Euralille",
        "Hellemmes lille",
        "Lezennes",
        "Lille",
        "Lomme"
      ],
      "groupedCityZipcodes": [
        "59000",
        "59160",
        "59260",
        "59777",
        "59800"
      ],
      "id": "37087",
      "insee": "59350",
      "libelle": "Lille",
      "location": {
        "lat": 50.629059,
        "lon": 3.06038
      },
      "name": "Lille",
      "zipcode": "59000"
    }
  ]
}