GET /v1/place/resolve

Returns the full address record for a placeId returned by /v1/suggest.

Required scope: geocoding:read

Request

GET /v1/place/resolve?id=ChIJi85p5P0ldTERfqSM08G0C1Q
X-API-Key: gdk_live_xxxxxxxxxxxxxxxxxxxxxxxx

Query parameters

Name	Required	Description
`id`	yes	The `placeId` from a previous `/v1/suggest` call.
`lang`	no	Language code, defaults to `vi`.
`sessionToken`	no	Same `sessionToken` used in the originating suggest call.

Response

{
  "result": {
    "placeId": "ChIJi85p5P0ldTERfqSM08G0C1Q",
    "name": "201 Trần Não",
    "address": "201 Trần Não, Thành phố, An Khánh, Hồ Chí Minh 700000, Việt Nam",
    "lat": 10.7866056,
    "lon": 106.7298182,
    "district": "Phường An Khánh",
    "city": "Thành phố Hồ Chí Minh",
    "country": "VN"
  },
  "source": "postgres",
  "elapsed_ms": 6
}

Response fields

Field	Type	Description
`result.placeId`	string	Same identifier passed in.
`result.name`	string	Short display name (POI name or street + number).
`result.address`	string	Full formatted address.
`result.lat`	number	Latitude in decimal degrees.
`result.lon`	number	Longitude in decimal degrees. (Note: not `lng`.)
`result.district`	string	Administrative ward / district name. May be null.
`result.city`	string	City / province name. May be null.
`result.country`	string	ISO 3166 alpha-2 country code.
`source`	string	Layer that served the response.
`elapsed_ms`	number	Server-side processing time.

Common errors

400 BAD_REQUEST — id missing.
401 INVALID_API_KEY / 403 INSUFFICIENT_SCOPE — auth/scope failure.
503 — place could not be resolved (no upstream provider available).

GET /v1/place/resolve

Request

Query parameters

Response

Response fields

Common errors

On this page