Use when you need a search request that can handle combinations of addresses and POI tokens.

The Get Search Fuzzy (Free Form Search) API, an HTTP GET request that seamlessly handles a combination of POI search and geocoding. It is a Free Form Search API which handles fuzzy of inputs containing any combination of address or POI tokens as a canonical 'single line search'. It can also be weighted with a contextual position (lat/lon pair), or fully constrained by a coordinate and radius, or it can be executed more generally without any geo biasing anchor point.<br><br>We strongly advise you to use the 'countrySet' parameter to specify only the countries/regions for which your application needs coverage, as the default behavior will be to search the entire world, potentially returning unnecessary results.<br><br> E.g.: countrySet=US,FR <br><br>Please see Search Coverage for a complete list of all the supported countries/regions.<br><br>Most Search queries default to maxFuzzyLevel=2 to gain performance and also reduce unusual results. This new default can be overridden as needed per request by passing in the query param maxFuzzyLevel=3 or 4.

get/search/fuzzy/{format}

Query parameters

api-versionstring required

Version number of Azure Maps API.

querystring required

The applicable query string (e.g., "seattle", "pizza"). Can also be specified as a comma separated string composed by latitude followed by longitude (e.g., "47.641268, -122.125679"). Must be properly URL encoded.

typeaheadboolean

Boolean. If the typeahead flag is set, the query will be interpreted as a partial input and the search will enter predictive mode

limitinteger

Maximum number of responses that will be returned. Default: 10, minimum: 1 and maximum: 100

ofsinteger

Starting offset of the returned results within the full result set. Default: 0

categorySetinteger[]

A comma-separated list of category set IDs which could be used to restrict the result to specific Points of Interest categories. ID order does not matter. Maximum number of categorySet values supported per request is 10. When multiple category identifiers are provided, only POIs that belong to (at least) one of the categories from the provided list will be returned. The list of supported categories can be discovered using POI Categories API. Usage examples:

  • categorySet=7315 (Search Points of Interest from category Restaurant)

  • categorySet=7315025,7315017 (Search Points of Interest of category either Italian or French Restaurant)

countrySetstring[]

Comma separated string of country/region codes, e.g. FR,ES. This will limit the search to the specified countries/regions

latnumber double

Latitude where results should be biased. E.g. 37.337

lonnumber double

Longitude where results should be biased. E.g. -121.89

radiusinteger

The radius in meters to for the results to be constrained to the defined area

topLeftstring

Top left position of the bounding box. E.g. 37.553,-122.453

btmRightstring

Bottom right position of the bounding box. E.g. 37.553,-122.453

extendedPostalCodesForstring[]

Indexes for which extended postal codes should be included in the results.

Available indexes are:

Addr = Address ranges

Geo = Geographies

PAD = Point Addresses

POI = Points of Interest

Str = Streets

XStr = Cross Streets (intersections)

Value should be a comma separated list of index types (in any order) or None for no indexes.

By default extended postal codes are included for all indexes except Geo. Extended postal code lists for geographies can be quite long so they have to be explicitly requested when needed.

Usage examples:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

Extended postal code is returned as an extendedPostalCode property of an address. Availability is region-dependent.

minFuzzyLevelinteger

Minimum fuzziness level to be used. Default: 1, minimum: 1 and maximum: 4

  • Level 1 has no spell checking.

  • Level 2 uses normal n-gram spell checking. For example, query "restrant" can be matched to "restaurant."

  • Level 3 uses sound-like spell checking, and shingle spell checking. Sound-like spell checking is for "rstrnt" to "restaurant" matching. Shingle spell checking is for "mountainview" to "mountain view" matching.

  • Level 4 doesn’t add any more spell checking functions.

The search engine will start looking for a match on the level defined by minFuzzyLevel, and will stop searching at the level specified by maxFuzzyLevel.

maxFuzzyLevelinteger

Maximum fuzziness level to be used. Default: 2, minimum: 1 and maximum: 4

  • Level 1 has no spell checking.

  • Level 2 uses normal n-gram spell checking. For example, query "restrant" can be matched to "restaurant."

  • Level 3 uses sound-like spell checking, and shingle spell checking. Sound-like spell checking is for "rstrnt" to "restaurant" matching. Shingle spell checking is for "mountainview" to "mountain view" matching.

  • Level 4 doesn’t add any more spell checking functions.

The search engine will start looking for a match on the level defined by minFuzzyLevel, and will stop searching at the level specified by maxFuzzyLevel.

idxSetstring[]

A comma separated list of indexes which should be utilized for the search. Item order does not matter. Available indexes are: Addr = Address range interpolation, Geo = Geographies, PAD = Point Addresses, POI = Points of interest, Str = Streets, Xstr = Cross Streets (intersections)

brandSetstring[]

A comma-separated list of brand names which could be used to restrict the result to specific brands. Item order does not matter. When multiple brands are provided, only results that belong to (at least) one of the provided list will be returned. Brands that contain a "," in their name should be put into quotes.

Usage examples:

brandSet=Foo

brandSet=Foo,Bar

brandSet="A,B,C Comma",Bar

connectorSetstring[]

A comma-separated list of connector types which could be used to restrict the result to Electric Vehicle Station supporting specific connector types. Item order does not matter. When multiple connector types are provided, only results that belong to (at least) one of the provided list will be returned.

Available connector types are:

  • StandardHouseholdCountrySpecific - These are the standard household connectors for a certain region. They are all AC single phase and the standard Voltage and standard Amperage. See also: Plug & socket types - World Standards.
  • IEC62196Type1 - Type 1 connector as defined in the IEC 62196-2 standard. Also called Yazaki after the original manufacturer or SAE J1772 after the standard that first published it. Mostly used in combination with 120V single phase or up to 240V single phase infrastructure.
  • IEC62196Type1CCS - Type 1 based combo connector as defined in the IEC 62196-3 standard. The connector is based on the Type 1 connector – as defined in the IEC 62196-2 standard – with two additional direct current (DC) contacts to allow DC fast charging.
  • IEC62196Type2CableAttached - Type 2 connector as defined in the IEC 62196-2 standard. Provided as a cable and plug attached to the charging point.
  • IEC62196Type2Outlet - Type 2 connector as defined in the IEC 62196-2 standard. Provided as a socket set into the charging point.
  • IEC62196Type2CCS - Type 2 based combo connector as defined in the IEC 62196-3 standard. The connector is based on the Type 2 connector – as defined in the IEC 62196-2 standard – with two additional direct current (DC) contacts to allow DC fast charging.
  • IEC62196Type3 - Type 3 connector as defined in the IEC 62196-2 standard. Also called Scame after the original manufacturer. Mostly used in combination with up to 240V single phase or up to 420V three phase infrastructure.
  • Chademo - CHAdeMO connector named after an association formed by the Tokyo Electric Power Company and industrial partners. Because of this is is also known as the TEPCO's connector. It supports fast DC charging.
  • IEC60309AC1PhaseBlue - Industrial Blue connector is a connector defined in the IEC 60309 standard. It is sometime referred to as by some combination of the standard, the color and the fact that is a single phase connector. The connector usually has the "P+N+E, 6h" configuration.
  • IEC60309DCWhite - Industrial White connector is a DC connector defined in the IEC 60309 standard.
  • Tesla - The Tesla connector is the regionally specific Tesla Supercharger connector. I.e. it refers to either Tesla's proprietary connector, sometimes referred to as Tesla Port mostly limited to North America or the modified Type 2 (DC over Type 2) in Europe.

Usage examples:

connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached

entityType'Country' | 'CountrySubdivision' | 'CountrySecondarySubdivision' | 'CountryTertiarySubdivision' | 'Municipality' | 'MunicipalitySubdivision' | 'Neighbourhood' | 'PostalCodeArea'

Specifies the level of filtering performed on geographies. Narrows the search for specified geography entity types, e.g. return only municipality. The resulting response will contain the geography ID as well as the entity type matched. If you provide more than one entity as a comma separated list, endpoint will return the 'smallest entity available'. Returned Geometry ID can be used to get the geometry of that geography via Get Search Polygon API. The following parameters are ignored when entityType is set:

  • heading
  • number
  • returnRoadUse
  • returnSpeedLimit
  • roadUse
  • returnMatchType
openingHours'nextSevenDays'

Hours of operation for a POI (Points of Interest). The availability of hours of operation will vary based on the data available. If not passed, then no opening hours information will be returned. Supported value: nextSevenDays

Parameters

../../../Common/preview/1.0/common.json#/components/parameters/ClientId — unresolved $ref
../../../Common/preview/1.0/common.json#/components/parameters/ResponseFormat — unresolved $ref
../../../Common/preview/1.0/common.json#/components/parameters/Language — unresolved $ref
../../../Common/preview/1.0/common.json#/components/parameters/View — unresolved $ref

Response

OK

Changes