Address search

GET /address_whisper

The primary autocomplete endpoint. Pass whatever the user has typed in s and get back ranked, deduplicated address suggestions. Provide country to scope results and lon/lat to bias them toward a location.

Query parameters

Request

cURL

Code(bash)
 
curl -G 'https://api.polaris.launify.com/address_whisper' \
  -H 'Referer: https://yourapp.com' \
  --data-urlencode 's=Národní 223' \
  --data-urlencode 'country=CZ' \
  --data-urlencode 'lon=14.41' \
  --data-urlencode 'lat=50.08' \
  --data-urlencode 'apiKey=YOUR_API_KEY'

JavaScript

Code(js)
 
const url = new URL('https://api.polaris.launify.com/address_whisper');
url.searchParams.set('s', 'Národní 223');
url.searchParams.set('country', 'CZ');
url.searchParams.set('lon', '14.41');
url.searchParams.set('lat', '50.08');
url.searchParams.set('apiKey', 'YOUR_API_KEY');

const suggestions = await fetch(url).then((r) => r.json());

Response

200 OK — an array of result objects.

Code(json)
 
[
  {
    "label": "Národní 223/2, Praha - Nové Město, 11000",
    "value": "Národní 223/2, Praha - Nové Město, 11000",
    "lon": 14.41346,
    "lat": 50.08125,
    "street": "Národní 223/2",
    "city": "Praha - Nové Město",
    "postcode": "11000",
    "country": "CZ",
    "details": {
      "housenumber": "223",
      "orientationnumber": "2",
      "street": "Národní",
      "city": "Praha",
      "district": "Nové Město",
      "postcode": "11000",
      "municipality": "",
      "province": "Středočeský kraj",
      "county": "Hlavní město Praha",
      "state": "",
      "country": "CZ"
    }
  }
]

Result object

details object