mottibec / lhee

Lhee

A city autocomplete API

Endpoint

• the endpoint is exposed at /suggestions
• the partial (or complete) search term is passed as a query string parameter q
• the caller's location can optionally be supplied via query string parameters latitude and longitude to help improve relative scores
• the endpoint returns a JSON response with an array of scored suggested matches

Sample responses

These responses are meant to provide guidance. The exact values can vary based on the data source and scoring algorithm.

Near match

GET /suggestions?q=Londo&latitude=43.70011&longitude=-79.4163

{
  "suggestions": [
    {
      "name": "London, ON, Canada",
      "latitude": "42.98339",
      "longitude": "-81.23304",
      "score": 0.9
    },
    {
      "name": "London, OH, USA",
      "latitude": "39.88645",
      "longitude": "-83.44825",
      "score": 0.5
    },
    {
      "name": "London, KY, USA",
      "latitude": "37.12898",
      "longitude": "-84.08326",
      "score": 0.5
    },
    {
      "name": "Londontowne, MD, USA",
      "latitude": "38.93345",
      "longitude": "-76.54941",
      "score": 0.3
    }
  ]
}

No match

GET /suggestions?q=SomeRandomCity

{
  "suggestions": []
}