List the ancestors of an administrative division (breadcrumb / drill-up)
Returns the parent chain of the given division up to the country root — for example a neighborhood, its arrondissement, commune, department, region and country. By default the division itself is excluded and the chain is ordered root first (country first). Use order=NODE_FIRST for immediate-parent first, and includeSelf=true to prepend the division for a ready-to-render breadcrumb.
Authorization
apiKey Value for the X-API-KEY header parameter.
In: header
Path Parameters
Administrative division id.
Query Parameters
Ordering of the chain: ROOT_FIRST (country first, the default) or NODE_FIRST (immediate parent first).
Value in
- "ROOT_FIRST"
- "NODE_FIRST"
Include the division itself in the chain. Defaults to false.
Response Body
curl -X GET "https://example.com/geo/administrative-divisions/3fa85f64-5717-4562-b3fc-2c963f66afa6/ancestors?order=ROOT_FIRST&includeSelf=false"[ { "name": "Paris", "uniqueCode": "75056", "locationType": "MUNICIPALITY", "countryCode": "FR", "postalCodes": [ "75001", "75002", "75003" ], "centroid": { "type": "Point", "coordinates": [ 2.3522, 48.8566 ] }, "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }]Get the boundary of an administrative division GET
Returns the administrative boundary as GeoJSON, ready to draw on a map. The outline is simplified to a level of detail suited to the division size, so a large region stays a small response. Contours change only when location data is reimported, so the response can be cached by the client.
List the descendants of an administrative division, at any depth GET
Returns every division below the given one, across intermediate levels, optionally filtered by type and bounded by maxDepth. maxDepth of 1 returns only the direct children. Use this to list, for example, every neighborhood of a city — including Paris, Lyon and Marseille, whose neighborhoods sit under an arrondissement. Set includeSelf=true to also return the division itself (its full scope: the division and everything below).