curl --location -g --request GET 'https://api.stream.estate/cities' \
--header 'Content-Type: application/json'
--header 'X-API-KEY:'
{
"hydra:member": [
{
"@id": "/cities/1",
"@type": "City",
"zipcode": "01500",
"insee": "01004",
"article": "",
"name": "Ambérieu-en-Bugey",
"libelle": "AMBERIEU EN BUGEY",
"department": "/departments/1",
"cityParent": {
"@id": "/cities/37152",
"@type": "City",
"zipcode": "01500",
"insee": "01004",
"article": "",
"name": null,
"libelle": null
},
"originalName": "Ambérieu-en-Bugey"
},
{
"@id": "/cities/2",
"@type": "City",
"zipcode": "01330",
"insee": "01005",
"article": "",
"name": "Ambérieux-en-Dombes",
"libelle": "AMBERIEUX EN DOMBES",
"department": "/departments/1",
"cityParent": {
"@id": "/cities/37153",
"@type": "City",
"zipcode": "01330",
"insee": "01005",
"article": "",
"name": null,
"libelle": null
},
"originalName": "Ambérieux-en-Dombes"
}
]
}
Indicators
Cities
This endpoint returns cities matching the given criteria.
GET
/
cities
curl --location -g --request GET 'https://api.stream.estate/cities' \
--header 'Content-Type: application/json'
--header 'X-API-KEY:'
{
"hydra:member": [
{
"@id": "/cities/1",
"@type": "City",
"zipcode": "01500",
"insee": "01004",
"article": "",
"name": "Ambérieu-en-Bugey",
"libelle": "AMBERIEU EN BUGEY",
"department": "/departments/1",
"cityParent": {
"@id": "/cities/37152",
"@type": "City",
"zipcode": "01500",
"insee": "01004",
"article": "",
"name": null,
"libelle": null
},
"originalName": "Ambérieu-en-Bugey"
},
{
"@id": "/cities/2",
"@type": "City",
"zipcode": "01330",
"insee": "01005",
"article": "",
"name": "Ambérieux-en-Dombes",
"libelle": "AMBERIEUX EN DOMBES",
"department": "/departments/1",
"cityParent": {
"@id": "/cities/37153",
"@type": "City",
"zipcode": "01330",
"insee": "01005",
"article": "",
"name": null,
"libelle": null
},
"originalName": "Ambérieux-en-Dombes"
}
]
}
Query parameters
boolean
default:"false"
Set to true to exclude cities that have grouped cities under them.
Example:
excludeGroupedCities=truestring
Filter by INSEE code.
array of strings
Filter by multiple INSEE codes.
string
Filter by cities inside a given polygon defined by GPS coordinates.
Example:
polygon=polygon[0][lat]=43.12&polygon[0][lon]=5.93&polygon[1][lat]=43.12&polygon[1][lon]=6.01&polygon[2][lat]=43.07&polygon[2][lon]=6.01&polygon[3][lat]=43.07&polygon[3][lon]=5.93string
Filter by city label/display name.
string
Filter by city name.
string
default:"asc"
Sort by name.
Enum:
"asc" "desc"integer
default:"1"
The collection page number.
string
Filter by city slug.
string
Filter by zipcode.
array of strings
Filter by multiple zipcodes.
curl --location -g --request GET 'https://api.stream.estate/cities' \
--header 'Content-Type: application/json'
--header 'X-API-KEY:'
{
"hydra:member": [
{
"@id": "/cities/1",
"@type": "City",
"zipcode": "01500",
"insee": "01004",
"article": "",
"name": "Ambérieu-en-Bugey",
"libelle": "AMBERIEU EN BUGEY",
"department": "/departments/1",
"cityParent": {
"@id": "/cities/37152",
"@type": "City",
"zipcode": "01500",
"insee": "01004",
"article": "",
"name": null,
"libelle": null
},
"originalName": "Ambérieu-en-Bugey"
},
{
"@id": "/cities/2",
"@type": "City",
"zipcode": "01330",
"insee": "01005",
"article": "",
"name": "Ambérieux-en-Dombes",
"libelle": "AMBERIEUX EN DOMBES",
"department": "/departments/1",
"cityParent": {
"@id": "/cities/37153",
"@type": "City",
"zipcode": "01330",
"insee": "01005",
"article": "",
"name": null,
"libelle": null
},
"originalName": "Ambérieux-en-Dombes"
}
]
}