Sign in

v1

latestOpenAPI 3.0.02026-07-1419035.1 KB
Search

Geometry Search

get/search/{versionNumber}/geometrySearch/{query}.{ext}

Path parameters

versionNumber2 required

Service version number. The current value is 2.

querystring required

Query string. Must be properly URL encoded.

ext'json' | 'jsonp' | 'js' | 'xml' required

Expected response format.

Query parameters

geometryListstring

List of geometries to filter by. Available types are CIRCLE (with the radius expressed in meters) and POLYGON.

limitinteger

Maximum number of search results that will be returned.

languagestring

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.

extendedPostalCodesForstring

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)
idxSetstring

A comma separated list of indexes which should be utilized for the search. Item order does not matter. Available indexes are:

  • <b>Addr</b> = Address range interpolation (when there is no PAD)
  • <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)

Response

OK: the search successfully returned zero or more results.