You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/azure-maps/glossary.md
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -151,6 +151,8 @@ The following list describes common words used with the Azure Maps services.
151
151
152
152
## G
153
153
154
+
<aname="geobias"></a> **Geobias**: A geospatial bias to improve the ranking of results. In some methods, this can be affected by setting the longitude and latitude parameters where available. In other cases it is purely internal.
155
+
154
156
<aname="geocode"></a> **Geocode**: An address or location that has been converted into a coordinate that can be used to display that location on a map.
155
157
156
158
<aname="geocoding"></a> **Geocoding**: Or _forward geocoding_, is the process of converting address of location data into coordinates.
Copy file name to clipboardExpand all lines: articles/azure-maps/how-to-search-for-address.md
+49-42Lines changed: 49 additions & 42 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ title: Search for a location using Azure Maps Search services
3
3
description: Learn about the Azure Maps Search service. See how to use this set of APIs for geocoding, reverse geocoding, fuzzy searches, and reverse cross street searches.
4
4
author: farazgis
5
5
ms.author: fsiddiqui
6
-
ms.date: 10/28/2021
6
+
ms.date: 8/9/2024
7
7
ms.topic: how-to
8
8
ms.service: azure-maps
9
9
ms.subservice: routing
@@ -25,36 +25,44 @@ This article demonstrates how to:
25
25
* An [Azure Maps account]
26
26
* A [subscription key]
27
27
28
-
This tutorial uses the [Postman] application, but you may choose a different API development environment.
28
+
>[!IMPORTANT]
29
+
>
30
+
> In the URL examples in this article you will need to replace `{Your-Azure-Maps-Subscription-key}` with your Azure Maps subscription key.
31
+
32
+
This article uses the [bruno] application, but you can choose a different API development environment.
29
33
30
34
## Request latitude and longitude for an address (geocoding)
31
35
32
36
The example in this section uses [Get Search Address] to convert an address into latitude and longitude coordinates. This process is also called *geocoding*. In addition to returning the coordinates, the response also returns detailed address properties such as street, postal code, municipality, and country/region information.
33
37
34
-
>[!TIP]
35
-
>If you have a set of addresses to geocode, you can use [Post Search Address Batch] to send a batch of queries in a single request.
38
+
>[!TIP]
39
+
>If you have a set of addresses to geocode, you can use [Post Search Address Batch] to send a batch of queries in a single request.
36
40
37
-
1.In the Postman app, select **New** to create the request. In the **Create New** window, select**HTTP Request**. Enter a **Request name** for the request.
41
+
1.Open the bruno app, select **NEW REQUEST** to create the request. In the **NEW REQUEST** window, set**Type** to **HTTP**. Enter a **Name** for the request.
38
42
39
-
2. Select the **GET** HTTP method in the builder tab and enter the following URL. In this request, we're searching for a specific address: `400 Braod St, Seattle, WA 98109`. For this request, and other requests mentioned in this article, replace `{Your-Azure-Maps-Subscription-key}` with your Azure Maps subscription key.
43
+
1. Select the **GET** HTTP method in the **URL** drop-down list, then enter the following URL:
40
44
41
45
```http
42
46
https://atlas.microsoft.com/search/address/json?&subscription-key={Your-Azure-Maps-Subscription-key}&api-version=1.0&language=en-US&query=400 Broad St, Seattle, WA 98109
43
47
```
44
48
45
-
3. Select the blue **Send** button. The response body contains data for a single location.
49
+
1. Select the **Create** button.
50
+
51
+
1. Select the run button.
46
52
47
-
4. Next, search an address that has more than one possible locations. In the **Params** section, change the `query` key to `400 Broad, Seattle`. Select the blue **Send** button.
53
+
This request searches for a specific address: `400 Broad St, Seattle, WA 98109`. Next, search an address that has more than one possible location.
54
+
55
+
1. In the **Params** section, change the `query` key to `400 Broad, Seattle`, then select the run button.
48
56
49
57
:::image type="content" source="./media/how-to-search-for-address/search-address.png" alt-text="Search for address":::
50
58
51
-
5. Next, try setting the `query` key to `400 Broa`.
59
+
1. Next, try setting the `query` key to `400 Broa`, then select the run button.
52
60
53
-
6. Select the **Send** button. The response includes results from multiple countries/regions. To geobias results to the relevant area for your users, always add as many location details as possible to the request.
61
+
The response includes results from multiple countries/regions. To [geobias] results to the relevant area for your users, always add as many location details as possible to the request.
54
62
55
63
## Fuzzy Search
56
64
57
-
[Fuzzy Search] supports standard single line and free-form searches. We recommend that you use the Azure Maps Search Fuzzy API when you don't know your user input type for a search request. The query input can be a full or partial address. It can also be a Point of Interest (POI) token, like a name of POI, POI category or name of brand. Furthermore, to improve the relevance of your search results, constrain the query results using a coordinate location and radius, or by defining a bounding box.
65
+
[Fuzzy Search] supports standard single line and free-form searches. We recommend that you use the Azure Maps Search Fuzzy API when you don't know your user input type for a search request. The query input can be a full or partial address. It can also be a Point of Interest (POI) token, like a name of POI, POI category or name of brand. Furthermore, to improve the relevance of your search results, constrain the query results using a coordinate location and radius, or by defining a bounding box.
58
66
59
67
> [!TIP]
60
68
> Most Search queries default to `maxFuzzyLevel=1` to improve performance and reduce unusual results. Adjust fuzziness levels by using the `maxFuzzyLevel` or `minFuzzyLevel` parameters. For more information on `maxFuzzyLevel` and a complete list of all optional parameters, see [Fuzzy Search URI Parameters].
@@ -66,30 +74,30 @@ The example in this section uses `Fuzzy Search` to search the entire world for *
66
74
> [!IMPORTANT]
67
75
> To geobias results to the relevant area for your users, always add as many location details as possible. For more information, see [Best Practices for Search].
68
76
69
-
1. In the Postman app, select **New** to create the request. In the **Create New** window, select **HTTP Request**. Enter a **Request name** for the request.
77
+
1. Open the bruno app, select **NEW REQUEST** to create the request. In the **NEW REQUEST** window, set **Type** to **HTTP**. Enter a **Name** for the request.
70
78
71
-
2. Select the **GET** HTTP method in the builder tab and enter the following URL. For this request, and other requests mentioned in this article, replace `{Your-Azure-Maps-Subscription-key}` with your Azure Maps subscription key.
79
+
1. Select the **GET** HTTP method in the **URL** drop-down list, then enter the following URL:
> The _json_ attribute in the URL path determines the response format. This article uses json for ease of use and readability. To find other supported response formats, see the `format` parameter definition in the [URI Parameter reference] documentation.
79
87
80
-
3. Select **Send** and review the response body.
88
+
1. Select the run button, then review the response body.
81
89
82
-
The ambiguous query string for "pizza" returned 10 [point of interest result] (POI) in both the "pizza" and "restaurant" categories. Each result includes details such as street address, latitude and longitude values, view port, and entry points for the location. The results are now varied for this query, and aren't tied to any reference location.
90
+
The ambiguous query string for "pizza" returned 10 [point of interest] (POI) results in both the "pizza" and "restaurant" categories. Each result includes details such as street address, latitude and longitude values, view port, and entry points for the location. The results are now varied for this query, and aren't tied to any reference location.
83
91
84
-
In the next step, you'll use the `countrySet` parameter to specify only the countries/regions for which your application needs coverage. For a complete list of supported countries/regions, see [Search Coverage].
92
+
In the next step, you'll use the `countrySet` parameter to specify only the countries/regions for which your application needs coverage. For a complete list of supported countries/regions, see [Azure Maps geocoding coverage].
85
93
86
-
4. The default behavior is to search the entire world, potentially returning unnecessary results. Next, search for pizza only in the United States. Add the `countrySet` key to the **Params** section, and set its value to `US`. Setting the `countrySet` key to `US` bounds the results to the United States.
94
+
1. The default behavior is to search the entire world, potentially returning unnecessary results. Next, search for pizza only in the United States. Add the `countrySet` key to the **Params** section, and set its value to `US`. Setting the `countrySet` key to `US` bounds the results to the United States.
87
95
88
96
:::image type="content" source="./media/how-to-search-for-address/search-fuzzy-country.png" alt-text="Search for pizza in the United States":::
89
97
90
98
The results are now bounded by the country code and the query returns pizza restaurants in the United States.
91
99
92
-
5. To get an even more targeted search, you can search over the scope of a lat/lon coordinate pair. The following example uses the lat/lon coordinates of the Seattle Space Needle. Since we only want to return results within a 400-meters radius, we add the `radius` parameter. Also, we add the `limit` parameter to limit the results to the five closest pizza places.
100
+
1. To get an even more targeted search, you can search over the scope of a lat/lon coordinate pair. The following example uses the lat/lon coordinates of the Seattle Space Needle. Since we only want to return results within a 400-meters radius, we add the `radius` parameter. Also, we add the `limit` parameter to limit the results to the five closest pizza places.
93
101
94
102
In the **Params** section, add the following key/value pairs:
95
103
@@ -100,48 +108,48 @@ The example in this section uses `Fuzzy Search` to search the entire world for *
100
108
| radius | 400 |
101
109
| limit | 5 |
102
110
103
-
6. Select **Send**. The response includes results for pizza restaurants near the Seattle Space Needle.
111
+
1. Select run. The response includes results for pizza restaurants near the Seattle Space Needle.
104
112
105
113
## Search for a street address using Reverse Address Search
106
114
107
115
[Get Search Address Reverse] translates coordinates into human readable street addresses. This API is often used for applications that consume GPS feeds and want to discover addresses at specific coordinate points.
108
116
109
117
> [!IMPORTANT]
110
-
> To geobias results to the relevant area for your users, always add as many location details as possible. For more information, see [Best Practices for Search].
118
+
> To [geobias] results to the relevant area for your users, always add as many location details as possible. For more information, see [Best Practices for Search].
111
119
112
120
> [!TIP]
113
121
> If you have a set of coordinate locations to reverse geocode, you can use [Post Search Address Reverse Batch] to send a batch of queries in a single request.
114
122
115
123
This example demonstrates making reverse searches using a few of the optional parameters that are available. For the full list of optional parameters, see [Reverse Search Parameters].
116
124
117
-
1. In the Postman app, select **New** to create the request. In the **Create New** window, select **HTTP Request**. Enter a **Request name** for the request.
125
+
1. Open the bruno app, select **NEW REQUEST** to create the request. In the **NEW REQUEST** window, set **Type** to **HTTP**. Enter a **Name** for the request.
118
126
119
-
2. Select the **GET** HTTP method in the builder tab and enter the following URL. For this request, and other requests mentioned in this article, replace `{Your-Azure-Maps-Subscription-key}` with your Azure Maps subscription key. The request should look like the following URL:
127
+
1. Select the **GET** HTTP method in the **URL** drop-down list, then enter the following URL:
3. Select **Send**, and review the response body. You should see one query result. The response includes key address information about Safeco Field.
133
+
1. Select the run button, and review the response body. You should see one query result. The response includes key address information about Safeco Field.
126
134
127
-
4. Next, add the following key/value pairs to the **Params** section:
135
+
1. Next, add the following key/value pairs to the **Params** section:
128
136
129
-
| Key | Value | Returns
130
-
|-----|------------|------|
131
-
| number | 1 |The response may include the side of the street (Left/Right) and also an offset position for the number.|
137
+
| Key | Value | Returns |
138
+
|-----|-------|---------|
139
+
| number | 1 |The response can include the side of the street (Left/Right) and also an offset position for the number.|
132
140
| returnSpeedLimit | true | Returns the speed limit at the address.|
133
141
| returnRoadUse | true | Returns road use types at the address. For all possible road use types, see [Road Use Types].|
134
-
| returnMatchType | true| Returns the type of match. For all possible values, see [Reverse Address Search Results].
142
+
| returnMatchType | true| Returns the type of match. For all possible values, see [Reverse Address Search Results]. |
1. Select the run button, and review the response body.
139
147
140
-
6. Next, we add the `entityType` key, and set its value to `Municipality`. The `entityType` key overrides the `returnMatchType` key in the previous step. `returnSpeedLimit` and `returnRoadUse` also need removed since you're requesting information about the municipality. For all possible entity types, see [Entity Types].
148
+
1. Next, add the `entityType` key, and set its value to `Municipality`. The `entityType` key overrides the `returnMatchType` key in the previous step. `returnSpeedLimit` and `returnRoadUse` also need removed since you're requesting information about the municipality. For all possible entity types, see [Entity Types].
7. Select **Send**. Compare the results to the results returned in step 5. Because the requested entity type is now `municipality`, the response doesn't include street address information. Also, the returned `geometryId` can be used to request boundary polygon through Azure Maps Get [Search Polygon API].
152
+
1. Select the run button. Compare the results to the results returned in step 5. Because the requested entity type is now `municipality`, the response doesn't include street address information. Also, the returned `geometryId` can be used to request boundary polygon through Azure Maps Get [Search Polygon API].
145
153
146
154
> [!TIP]
147
155
> For more information on these as well as other parameters, see [Reverse Search Parameters].
@@ -150,17 +158,15 @@ This example demonstrates making reverse searches using a few of the optional pa
150
158
151
159
This example demonstrates how to search for a cross street based on the coordinates of an address.
152
160
153
-
1. In the Postman app, select **New** to create the request. In the **Create New** window, select **HTTP Request**. Enter a **Request name** for the request.
161
+
1. Open the bruno app, select **NEW REQUEST** to create the request. In the **NEW REQUEST** window, set **Type** to **HTTP**. Enter a **Name** for the request.
154
162
155
-
2. Select the **GET** HTTP method in the builder tab and enter the following URL. For this request, and other requests mentioned in this article, replace `{Your-Azure-Maps-Subscription-key}` with your Azure Maps subscription key. The request should look like the following URL:
163
+
1. Select the **GET** HTTP method in the **URL** drop-down list, then enter the following URL:
0 commit comments