v1

latestOpenAPI 3.0.02026-07-1419035.1 KB
Search

Routed Search

get/search/{versionNumber}/routedSearch/{query}/{position}/{heading}.{ext}

Path parameters

versionNumber2 required

Service version number. The current value is 2.

querystring required

Query string. Must be properly URL encoded.

positionstring required

This is specified as a comma separated string composed of lat., lon.

headingnumber float required

The directional heading in degrees, usually similar to the course along a road segment. Entered in degrees, measured clockwise from north (so north is 0, east is 90, etc.)

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.

multiplierinteger

Multiplies the limit by N to gather more candidate POIs, which will then be sorted by drive distance, returning only the top candidates according to the limit.

routingTimeoutinteger

Only return results that arrive from routing engine within this time limit.

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.