Sign in

v2

latestOpenAPI 3.1.02026-08-0176498.0 KB
Location endpoints

Prefix search for places. Useful for autocomplete forms.

Search for places by prefix

You can use this endpoint to obtain place_id of the location you want, to be used in point endpoint. The response also contains detailed information about the location, such as coordinates, timezone and the country the place belongs to.

Unlike the /find_places endpoint, you should only specify the prefix of the place you are looking for. This is particularly useful for autocomplete forms. You can search for cities, mountains, lakes, countries, ZIP codes, etc. The response can contain multiple places, sorted by relevance. You can then identify the one you want by coordinates, country, or the administrative area.

get/find_places_prefix

Query parameters

textstring required

Place name or ZIP code

Place name or ZIP code

language'cs' | 'en' | 'de' | 'es' | 'fr' | 'pl' | 'pt'

The language of text summaries and place names (variable names are never translated). Available languages are:

  • en: English
  • es: Spanish
  • fr: French
  • de: German
  • pl: Polish
  • pt: Portuguese
  • cs: Czech
keystring

Your unique API key. You can either specify it in this parameter, or set it in X-API-Key header.

Your unique API key. You can either specify it in this parameter, or set it in X-API-Key header.

Response

Successful Response

namestring

name of the place

place_idstring

unique identifier of the place, which can be used in /point and /map endpoints

adm_area1string nullable

first-level administrative area (a US state, for example)

adm_area2string nullable

second-level administrative area (a US county, for example)

countrystring nullable

name of the country

latstring

Latitude of the point, always in the format <float><N/S>, for example 23.5S

lonstring

Longitude of the point, always in format <float><E/W>, for example 23.5W

timezonestring nullable

Timezone of the point in tzinfo format.

typestring

The character of the place. May be one of the following values:

  • administrative areas (states, counties, districts...): administrative_area
  • country: country
  • a different political entity from a country (for example, a dependent teritory): political_entity
  • villages, towns and cities: settlement
  • air industry locations: airbase, airfield, heliport, airport, airport_terminal
  • places related to water: bay, channel, fjord, lake, pond, falls, gulf, harbor, reservoir, sea, dam, cape, island, peninsula
  • places related to mountain areas: hill, mountain, peak, valley, volcano, canyon
  • other places related to nature: park, reserve, resort, desert
  • places based on postcodes: postcode