---
title: "Place detail with administrative hierarchy"
method: GET
path: "/api/v1/geocoding/details"
tags: ["Geocoding"]
---

# Place detail with administrative hierarchy

`GET /api/v1/geocoding/details`

Return administrative and topological detail for a single OpenStreetMap place. Provide either `place_id` (internal Nominatim identifier) OR the `osm_type` + `osm_id` pair (stable OSM identifier - preferred). `osm_type` accepts the single-letter form `N` (node), `W` (way), `R` (relation). Responses can be very large for famous places when the multilingual `names` map is populated. Intended for one-shot lookups, not live autocomplete. Data is (C) OpenStreetMap contributors (ODbL 1.0).

## Query parameters

- `place_id` integer, nullable — Internal Nominatim place identifier. Not stable across reindexes; prefer `osm_type` + `osm_id` for persistent references.
- `osm_type` string, nullable — OSM element variant in single-letter form: `N` node, `W` way, `R` relation.
- `osm_id` integer, nullable — Stable OpenStreetMap identifier within the `osm_type` namespace.
- `addressdetails` boolean — Include the structured address breakdown on the result.

## Response `200`

Administrative hierarchy and metadata for one place, (C) OpenStreetMap contributors (ODbL 1.0).

- EnvelopeNominatimDetailsPayload
  - `data` NominatimDetailsPayload, required — Response payload for `/api/v1/geocoding/details`. Exposes administrative / topological detail for a single place. The upstream `/details` response is passed through with Pydantic's extra-field tolerance so locale-specific fields (e.g. the 200-language `names` map for famous places) reach the caller without being dropped.
    - `place_id` integer, nullable — Internal Nominatim place identifier.
    - `parent_place_id` integer, nullable — Parent place identifier (0 when the place has no parent in the hierarchy).
    - `osm_type` string, nullable — OSM element variant in single-letter form: `N` node, `W` way, `R` relation.
    - `osm_id` integer, nullable — Stable OpenStreetMap identifier within the `osm_type` namespace.
    - `category` string, nullable — OSM top-level classification (e.g. `boundary`, `place`).
    - `type` string, nullable — OSM sub-classification within the `category`.
    - `admin_level` integer, nullable — Administrative level (2 country, 4 state/province, 6 county, 8 city).
    - `localname` string, nullable — Primary name of the place in the requested language.
    - `names` object, nullable — Multilingual names map (e.g. `name:en`, `name:fr`, `name:de`). Can be very large for famous places.
    - `country_code` string, nullable — ISO 3166-1 alpha-2 country code, lowercase.
    - `importance` number, nullable — Nominatim importance score 0.0-1.0.
    - `rank_address` integer, nullable — Internal Nominatim address rank (0-30).
    - `centroid` object, nullable — GeoJSON-style centroid object with `type` and `coordinates`.
    - `attribution` string — ODbL 1.0 attribution required on every surface that displays this data.
  - `meta` SugraMeta, required — Metadata attached to every /api/v1/* response envelope.
    - `endpoint` string, required — Requested endpoint path.
    - `data_time` string, required — ISO 8601 UTC timestamp of the source data, not of the request.
    - `response_time` string, required — ISO 8601 UTC timestamp when this response was produced.
    - `provider` string, required — API name and version.
    - `source` string, nullable — Identifier of the primary upstream source used for this response.
    - `attribution` string, nullable — Human-readable attribution mandated by an upstream source (e.g. a securities regulator or self-regulatory organization). Present only on responses whose source requires the owner and source to be clearly identified. Do not remove or alter it when using the response.
    - `fallback_used` boolean, nullable — True when the primary source failed and a fallback produced the data.
    - `fallback_chain` string[], nullable — Ordered list of sources attempted, in the order they were tried.
    - `cached` boolean, nullable — True when this response was served from the internal cache.
    - `stale` boolean, nullable — True when the cached response was returned after the upstream rate-limited or errored. Clients can use this to detect degraded data.

## Other responses

- `401` — Missing or invalid `x-api-key` header. JSON body with a stable `code` distinguishing `missing_api_key` (no header sent) from `invalid_api_key` (header sent, key not accepted); any other 401 source carries the generic `unauthorized` with its detail as `reason`. Plus `hint`. `plan` is always null on 401 - an unauthenticated request has no plan; quota exhaustion is 429, not 401.
- `422` — Validation Error
- `429` — Daily rate limit exceeded. Check `X-RateLimit-Reset` for the next window.
- `503` — Upstream source is temporarily unavailable. Retry after a short delay.

---

[API](https://skmtc.net/sugra/apis/sugra-api.md) · [All operations](https://skmtc.net/sugra/apis/sugra-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sugra/sugra-api/versions/4c4530760ba1/schema)