GLglobaldothealth
Suggest
Geocode

Suggests geocodes for a given query string

Changed on
get/geocode/suggest

Request

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

Query parameters

qstring required

The location string for which to find geocodes

limitToResolutionstring

Comma-separated list of resolutions to restrict geocoding to. Allowed values are: Point, Admin3, Admin2, Admin1, Country.

Response

OK

countrystring

ISO-3166-2 code of a country

administrativeAreaLevel1string

First administrative subdivision of a country

administrativeAreaLevel2string

Second administrative subdivision of a country

administrativeAreaLevel3string

Third administrative subdivision of a country

placestring

Name of the place this location refers to

namestring

Full name of the location

geoResolution'Point' | 'Admin3' | 'Admin2' | 'Admin1' | 'Country'

How granular the location is

Example response

[
  {
    "country": "CR",
    "administrativeAreaLevel1": "Any province in Costa Rica",
    "administrativeAreaLevel2": "Any canton in Costa Rica",
    "administrativeAreaLevel3": "Any district in Costa Rica",
    "place": "Boston Children's Hospital",
    "name": "Lyon, Auvergne-Rhône-Alpes, France"
  }
]

Changes

  • 252326d779c9Revision changes
    • info

      added the non-success response with the status

  • 2ac74d623d26Revision changes
    • info

      added the new optional query request parameter limitToResolution

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status