Sign in

v1

latestOpenAPI 3.0.02026-07-1419035.1 KB
Search

Fuzzy Search

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

Path parameters

versionNumber2 required

Service version number. The current value is 2.

querystring required

Query string. Must be properly URL encoded.

To perform a reverse geocode, the user can provide latitude and longitude coordinates directly in the query. More information can be found <a href="/search-api/search-api-documentation-search/fuzzy-search#AdditionalInfo">here</a>.

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

Expected response format.

Query parameters

typeaheadboolean

If the "typeahead" flag is set, the query will be interpreted as a partial input and the search will enter <b>predictive</b> mode.

limitinteger

Maximum number of search results that will be returned.

ofsinteger

Starting offset of the returned results within the full result set.

countrySetstring

Comma separated string of country codes. This will limit the search to the specified countries.

latnumber float

Latitude where results should be biased. NOTE: supplying a lat/lon without a radius will return search results biased to that point.

lonnumber float

Longitude where results should be biased NOTE: supplying a lat/lon without a radius will return search results biased to that point.

radiusinteger

If radius <b>and</b> position are set, the results will be constrained to the defined area. The radius parameter is specified in meters.

topLeftstring

Top left position of the bounding box. This is specified as a comma separated string composed of lat., lon.

btmRightstring

Bottom right position of the bounding box. This is specified as a comma separated string composed of lat., lon.

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

Minimum fuzziness level to be used.

maxFuzzyLevelinteger

Maximum fuzziness level to be used.

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)
view'Unified' | 'IN' | 'PK' | 'IL' | 'MA'

Geopolitical View.

Response

OK: the search successfully returned zero or more results.