---
title: "Suggests geocodes for a given query string"
method: GET
path: "/geocode/suggest"
tags: ["Suggest", "Geocode"]
---

# Suggests geocodes for a given query string

`GET /geocode/suggest`

## Request

- Base URL: `http://localhost:3001/api`
- URL: `http://localhost:3001/api/geocode/suggest`
- Auth: none declared

## Query parameters

- `q` string, required
- `limitToResolution` string

## Response `200`

OK

- Location[]: A list of geo locations
  - `country` string: ISO-3166-2 code of a country
  - `administrativeAreaLevel1` string: First administrative subdivision of a country
  - `administrativeAreaLevel2` string: Second administrative subdivision of a country
  - `administrativeAreaLevel3` string: Third administrative subdivision of a country
  - `place` string: Name of the place this location refers to
  - `name` string: Full name of the location
  - `geoResolution` 'Point' | 'Admin3' | 'Admin2' | 'Admin1' | 'Country': How granular the location is
  - `geometry` object
    - `latitude` number, required
    - `longitude` number, required

## Other responses

- `403`: Forbidden
- `422`: Unprocessable entity
- `500`: Internal server error

## Changes

- **2022-05-05** `252326d779c9`: 1 info
  - added the non-success response with the status `403`
- **2020-09-28** `2ac74d623d26`: 3 info
  - added the new optional `query` request parameter `limitToResolution`
  - added the non-success response with the status `422`
  - added the non-success response with the status `500`

[Operation history](https://skmtc.dev/globaldothealth/apis/global-health-curator-service-api/changes/geocode/suggest/get.md)

---

[API](https://skmtc.dev/globaldothealth/apis/global-health-curator-service-api.md) - [All operations](https://skmtc.dev/globaldothealth/apis/global-health-curator-service-api/llms.txt) - [OpenAPI document](https://skmtc.dev/globaldothealth/apis/global-health-curator-service-api/revisions/5b1151265235?raw)