| Description |
:
The `Get Search Fuzzy` (**Free Form Search**) API, an HTTP `GET` request that seamlessly handles a combination of [POI search](/rest/api/maps/search/get-search-poi?view=rest-maps-1.0) and [geocoding](/rest/api/maps/search/get-search-address?view=rest-maps-1.0). 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. 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. E.g.: `countrySet`=US,FR Please see [Search Coverage](/azure/location-based-services/geocoding-coverage) for a complete list of all the supported countries/regions. 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. |
| Reference | : Link ¶ |
⚶ Changes
{
"#id": "Search_GetSearchFuzzy",
"$responses": {
"200": {
"$properties": {
"results": {
"$properties": [
{
"#name": "address",
"Description": {
"new": "The address of the result.",
"old": "The address of the result"
},
"$properties": [
{
"#name": "buildingNumber",
"Description": {
"new": "The building number on the street.\n\n**Important**: This property is *deprecated*. Use `streetNumber` instead.",
"old": "The building number on the street.\n**Important**: This property is *deprecated*. Use `streetNumber` instead."
}
},
{
"#name": "street",
"Description": {
"new": "The street name.\n\n**Important**: This property is *deprecated*. Use `streetName` instead.",
"old": "The street name.\n**Important**: This property is *deprecated*. Use `streetName` instead."
}
},
{
"#name": "crossStreet",
"Description": {
"new": "The name of the street being crossed.\n\nThis property is only available in the `Get Search Address Reverse Cross Street` API.",
"old": "The name of the street being crossed."
}
},
{
"#name": "streetNumber",
"Description": {
"new": "The building number on the street.\n\nNot available in the `Get Search Address Reverse Cross Street` API.",
"old": "The building number on the street."
}
},
{
"#name": "routeNumbers",
"Description": {
"new": "The codes used to unambiguously identify the street.\n\nOnly available for the Search Address Reverse APIs.",
"old": "The codes used to unambiguously identify the street"
}
},
{
"#name": "streetNameAndNumber",
"Description": {
"new": "The street name and number.\n\nOnly available for the Search Address Reverse APIs.",
"old": "The street name and number.\nOnly available for the Search Address Reverse APIs."
}
},
{
"#name": "municipality",
"Description": {
"new": "City / Town
Note: `municipality` represents the residential municipality. Depending on the location, the `municipality` value may differ from the commonly known name of a city or town. For the commonly known name of the city or town, it's suggested that the `localName` value be used instead of the `municipality` value.",
"old": "City / Town
Note: `municipality` represents the residential municipality. Depending on the location, the `municipality` value may differ from the commonly known name of a city or town. For the commonly known name of the city or town, it\u2019s suggested that the `localName` value be used instead of the `municipality` value."
}
},
{
"#name": "countrySubdivision",
"Description": {
"new": "The primary administrative division within a country, such as a state, province. It is used to represent the first-level subdivision below the national level.",
"old": "State or Province"
}
},
{
"#name": "countrySecondarySubdivision",
"Description": {
"new": "The second-level administrative division within a country/region. It identifies a subdivision that is below the primary subdivision, such as state or province, but above smaller units like municipalities or neighborhoods. Examples include *County* in the United States and *District* in the United Kingdom.",
"old": "County"
}
},
{
"#name": "countryTertiarySubdivision",
"Description": {
"new": "The third-level administrative division within a country/region. It provides even finer granularity than the secondary subdivision (such as county or district). Examples include municipalities such as a city, town, village, borough, or township and neighborhoods a smaller, informal geographic area within a municipality such as Capitol Hill, Green Lake, and Wallingford in Seattle.",
"old": "Named Area"
}
},
{
"#name": "municipalitySubdivision",
"Description": {
"new": "A subdivision within a municipality. It represents a smaller administrative or geographic unit inside a city, town, or other municipal entity.",
"old": "Sub / Super City"
}
},
{
"#name": "countrySubdivisionName",
"Description": {
"new": "Represents the full name of the first-level administrative division (such as state, province, or region) within a country or region. This property is included only when the `countrySubdivision` value is provided in abbreviated form. Currently supported for the United States, Canada, and the United Kingdom.",
"old": "The full name of a first level of country/region administrative hierarchy. This field appears only in case countrySubdivision is presented in an abbreviated form. Only supported for USA, Canada, and United Kingdom."
}
},
{
"#name": "countrySubdivisionCode",
"Description": {
"new": "`countrySubdivisionCode` prefixed by `countryCode` ( countryCode-countrySubdivisionCode ) and the hyphen forms the ISO 3166-2 code. Examples: TX for Texas, SCT for Scotland and ON for Ontario.\n\nThis property is not available in the `Get Search Nearby` and `Get Search POI` API.",
"old": "`countrySubdivisionCode` prefixed by `countryCode` ( countryCode-countrySubdivisionCode ) and the hyphen forms the ISO 3166-2 code. Examples: TX for Texas, SCT for Scotland and ON for Ontario."
}
},
{
"#name": "postalCode",
"Description": {
"new": "A series of numbers or letters (or both) added to an address to help identify a specific geographic area. A ZIP Code is the U.S. version of a postal code, other countries/regions use other formats such as Postcode, PIN Code and PLZ.",
"old": "Postal Code / Zip Code"
}
},
{
"#name": "extendedPostalCode",
"Description": {
"new": "An extended postal code refers to a postal code format that goes beyond the standard set of digits to provide greater location precision. It is commonly used in systems like the U.S. ZIP+4 code or similar extended formats in other countries/regions. Availability is dependent on the region.\n\nNot available in the `Get Search Address Reverse Cross Street` API.",
"old": "Extended postal code (availability is dependent on the region)."
}
},
{
"#name": "country",
"Description": {
"new": "The country/region name.",
"old": "country/region name"
}
},
{
"#name": "countryCode",
"Description": {
"new": "A two-letter alphabetic code defined by the ISO 3166-1 Alpha-2 standard to represent a country/region and dependent territories.",
"old": "Country (Note: This is a two-letter code, not a country/region name.)"
}
},
{
"#name": "countryCodeISO3",
"Description": {
"new": "A three-letter alphabetic code defined by the ISO 3166-1 Alpha-3 standard to represent a country/region and dependent territories.",
"old": "ISO alpha-3 country code"
}
},
{
"#name": "freeformAddress",
"Description": {
"new": "An address line formatted according to the formatting rules of a result's country/region of origin, or in the case of a country/region, its full country/region name.",
"old": "An address line formatted according to the formatting rules of a Result's country/region of origin, or in the case of a country/region, its full country/region name."
}
}
]
}
]
}
}
}
}
}
⚼ Request
GET:
/search/fuzzy/{format}
{
x-ms-client-id:
string
,
api-version:
string
,
format:
string
,
query:
string
,
typeahead:
boolean
,
limit:
integer
,
ofs:
integer
,
categorySet:
array
,
countrySet:
array
,
lat:
number
,
lon:
number
,
radius:
integer
,
topLeft:
string
,
btmRight:
string
,
language:
string
,
extendedPostalCodesFor:
array
,
minFuzzyLevel:
integer
,
maxFuzzyLevel:
integer
,
idxSet:
array
,
brandSet:
array
,
connectorSet:
array
,
entityType:
string
,
view:
string
,
openingHours:
string
,
}
⚐ Response (200)
{
summary:
{
,
query:
string
,
queryType:
enum
,
queryTime:
integer
,
numResults:
integer
,
limit:
integer
,
offset:
integer
,
totalResults:
integer
,
fuzzyLevel:
integer
,
geoBias:
}
{
,
lat:
number
,
lon:
number
,
}
results:
}
[
]
,
{
,
type:
enum
,
id:
string
,
score:
number
,
dist:
number
,
info:
string
,
entityType:
enum
,
poi:
{
,
name:
string
,
phone:
string
,
url:
string
,
categorySet:
[
]
,
{
,
id:
integer
,
}
categories:
[
,
string
,
]
classifications:
[
]
,
{
,
code:
string
,
names:
}
[
]
,
{
,
nameLocale:
string
,
name:
string
,
}
brands:
[
]
,
{
,
name:
string
,
}
openingHours:
}
{
,
mode:
string
,
timeRanges:
}
[
]
,
{
,
startTime:
{
,
date:
string
,
hour:
integer
,
minute:
integer
,
}
endTime:
}
{
,
date:
string
,
hour:
integer
,
minute:
integer
,
}
address:
{
,
buildingNumber:
string
,
street:
string
,
crossStreet:
string
,
streetNumber:
string
,
routeNumbers:
[
,
string
,
]
streetName:
string
,
streetNameAndNumber:
string
,
neighbourhood:
string
,
municipality:
string
,
countrySubdivision:
string
,
countrySecondarySubdivision:
string
,
countryTertiarySubdivision:
string
,
municipalitySubdivision:
string
,
countrySubdivisionName:
string
,
countrySubdivisionCode:
string
,
postalCode:
string
,
extendedPostalCode:
string
,
country:
string
,
countryCode:
string
,
countryCodeISO3:
string
,
freeformAddress:
string
,
localName:
string
,
boundingBox:
}
{
,
northEast:
string
,
southWest:
string
,
entity:
enum
,
}
position:
{
,
lat:
number
,
lon:
number
,
}
viewport:
{
,
topLeftPoint:
{
,
lat:
number
,
lon:
number
,
}
btmRightPoint:
}
{
,
lat:
number
,
lon:
number
,
}
entryPoints:
[
]
,
{
,
type:
enum
,
position:
}
{
,
lat:
number
,
lon:
number
,
}
addressRanges:
{
,
rangeLeft:
string
,
rangeRight:
string
,
from:
{
,
lat:
number
,
lon:
number
,
}
to:
}
{
,
lat:
number
,
lon:
number
,
}
dataSources:
{
,
geometry:
}
{
,
id:
string
,
}
matchType:
enum
,
detourTime:
integer
,
}
⚐ Response (default)
{
error:
}
{
,
code:
string
,
message:
string
,
target:
string
,
details:
[
,
string
,
]
additionalInfo:
}
[
]
,
{
,
type:
string
,
info:
object
,
}