v1
latestOpenAPI 3.0.02026-07-1419035.1 KBPoints of Interest Search
Path parameters
Service version number. The current value is 2.
Query string. Must be properly URL encoded.
Expected response format.
Query parameters
If the "typeahead" flag is set, the query will be interpreted as a partial input and the search will enter <b>predictive</b> mode.
Maximum number of search results that will be returned.
Starting offset of the returned results within the full result set.
Comma separated string of country codes. This will limit the search to the specified countries.
Latitude where results should be biased. NOTE: supplying a lat/lon without a radius will return search results biased to that point.
Longitude where results should be biased NOTE: supplying a lat/lon without a radius will return search results biased to that point.
If radius <b>and</b> position are set, the results will be constrained to the defined area. The radius parameter is specified in meters.
Top left position of the bounding box. This is specified as a comma separated string composed of lat., lon.
Bottom right position of the bounding box. This is specified as a comma separated string composed of lat., lon.
Language in which search results should be returned. Should be one of <a href="/search-api/search-api-documentation/supported-languages">supported IETF language tags</a>, case insensitive.
Indexes for which extended postal codes should be included in the results. Available indexes are:
- <b>Addr</b> = Address ranges
- <b>Geo</b> = Geographies
- <b>PAD</b> = Point Addresses
- <b>POI</b> = Points of Interest
- <b>Str</b> = Streets
- <b>XStr</b> = Cross Streets (intersections)
Geopolitical View.
Response
OK: the search successfully returned zero or more results.