Search - Get Reverse Geocoding
用于从经度和纬度坐标获取街道地址和位置信息。
Get Reverse Geocoding API 是一个 HTTP GET 请求,用于将坐标(例如:37.786505、-122.3862)转换为人类可理解的街道地址。 可用于跟踪从设备或资产接收 GPS 源并想要知道与坐标关联的地址的应用程序。 此终结点将返回给定坐标的地址信息。
GET https://atlas.microsoft.com/reverseGeocode?api-version=2025-01-01&coordinates={coordinates}
GET https://atlas.microsoft.com/reverseGeocode?api-version=2025-01-01&coordinates={coordinates}&resultTypes={resultTypes}&view={view}
URI 参数
| 名称 | 在 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
api-version
|
query | True |
string |
Azure Maps API 的版本号。 |
|
coordinates
|
query | True |
number[] |
要反向地理编码的位置的坐标。 示例:&coordinates=lon,lat |
|
result
|
query |
指定响应中所需的实体类型。 仅返回指定的类型。 如果点无法映射到指定的实体类型,则响应中不会返回位置信息。 默认值是所有可能的实体。 从以下选项中选择的实体类型的逗号分隔列表。
这些实体类型从最具体的实体排序到最不具体的实体。 当找到多个实体类型的实体时,仅返回最具体的实体。 例如,如果将 Address 和 AdminDistrict1 指定为两种类型的实体类型和实体,则响应中仅返回 Address 实体信息。 |
||
|
view
|
query |
string |
一个字符串,表示 ISO 3166-1 Alpha-2 区域/国家/地区代码。 这将更改地缘政治争议的边框和标签,使其与指定的用户区域保持一致。 默认情况下,即使尚未在请求中定义视图参数,视图参数也会设置为“自动”。 有关详细信息,请参阅 支持的视图,并查看可用的视图。 |
请求头
| 名称 | 必需 | 类型 | 说明 |
|---|---|---|---|
| x-ms-client-id |
string |
指定哪个帐户与 Azure AD 安全模型结合使用。 它表示 Azure Maps 帐户的唯一 ID,可以从 Azure Maps 管理平面帐户 API 检索。 有关在 Azure Maps 中使用 Microsoft Entra ID 安全性的详细信息,请参阅 在 Azure Maps 中管理身份验证。 |
|
| Accept-Language |
string |
应返回搜索结果的语言。 有关详细信息,请参阅 支持的语言。 |
响应
| 名称 | 类型 | 说明 |
|---|---|---|
| 200 OK |
好的 Media Types: "application/geo+json" |
|
| Other Status Codes |
发生意外错误。 Media Types: "application/geo+json" |
安全性
AADToken
这些 Microsoft Entra OAuth 2.0 流。 与 Azure 基于角色的访问配对时, 控制它可用于控制对 Azure Maps REST API 的访问。 Azure 基于角色的访问控制用于指定对一个或多个 Azure Maps 资源帐户或子资源的访问。 任何用户、组或服务主体都可以通过内置角色或由一个或多个对 Azure Maps REST API 的权限组成的自定义角色授予访问权限。
若要实现方案,建议查看
注释
- 此安全定义 要求 使用
x-ms-client-id标头来指示应用程序请求访问的 Azure Maps 资源。 这可以从 地图管理 API获取。 -
Authorization URL特定于 Azure 公有云实例。 主权云具有唯一的授权 URL,Microsoft Entra ID 配置。 - Azure 基于角色的访问控制是通过 Azure 门户、PowerShell、CLI、Azure SDK 或 REST API 从 Azure 管理平面 配置的。
- 使用 Azure Maps Web SDK 允许为多个用例设置基于应用程序的配置。
- 有关Microsoft标识平台的详细信息,请参阅 Microsoft标识平台概述。
类型:
oauth2
流向:
implicit
授权 URL:
https://login.microsoftonline.com/common/oauth2/authorize
作用域
| 名称 | 说明 |
|---|---|
| https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
这是在通过 Azure 门户、PowerShell、CLI、Azure SDK 或 REST API 通过 Azure 管理平面创建 Azure Maps 资源 时预配的共享密钥。
使用此密钥,任何应用程序都有权访问所有 REST API。 换句话说,这些密钥当前可视为为其颁发的帐户的主密钥。
对于公开的应用程序,我们建议使用可安全地存储此密钥的 Azure Maps REST API 的服务器到服务器访问。
类型:
apiKey
在:
header
SAS Token
这是一个共享访问签名令牌,它通过 Azure 门户、PowerShell、CLI、Azure SDK 或 REST API 通过 Azure 管理平面在 azure Maps 资源
使用此令牌,任何应用程序都有权使用 Azure 基于角色的访问控制进行访问,并精细控制特定令牌的过期、速率和区域。 换句话说,SAS 令牌可用于允许应用程序以比共享密钥更安全的方式控制访问。
对于公开的应用程序,建议在 映射帐户资源 上配置允许的源的特定列表,以限制呈现滥用并定期续订 SAS 令牌。
类型:
apiKey
在:
header
示例
Search point -122.138681, 47.630358
示例请求
GET https://atlas.microsoft.com/reverseGeocode?api-version=2025-01-01&coordinates=-122.138681,47.630358
示例响应
Content-Type: application/geo+json
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"properties": {
"address": {
"countryRegion": {
"name": "United States"
},
"adminDistricts": [
{
"name": "Washington",
"shortName": "WA"
},
{
"name": "King County",
"shortName": "King Co."
}
],
"formattedAddress": "15127 NE 24th St, Redmond, Washington 98052",
"streetName": "NE 24th St",
"streetNumber": "15127",
"locality": "Redmond",
"postalCode": "98052",
"addressLine": "15127 NE 24th St"
},
"type": "Address",
"confidence": "Medium",
"matchCodes": [
"Good"
],
"geocodePoints": [
{
"geometry": {
"type": "Point",
"coordinates": [
-122.138681,
47.630358
]
},
"calculationMethod": "Rooftop",
"usageTypes": [
"Display"
]
},
{
"geometry": {
"type": "Point",
"coordinates": [
-122.1386787,
47.6302179
]
},
"calculationMethod": "Rooftop",
"usageTypes": [
"Route"
]
}
]
},
"geometry": {
"type": "Point",
"coordinates": [
-122.138681,
47.630358
]
},
"bbox": [
-122.14632282407,
47.626495282429325,
-122.13103917593001,
47.63422071757068
]
}
]
}
定义
| 名称 | 说明 |
|---|---|
| Address |
结果的地址 |
|
Admin |
地址所在国家或地区的细分名称。 此元素通常被视为第一个顺序管理细分,但在某些情况下,它还包含国家/地区、依赖项或区域的第二、第三或第四个顺序细分。 |
|
Calculation |
用于计算地理编码点的方法。 |
|
Confidence |
地理编码位置结果匹配的置信度级别。 将此值与匹配代码一起使用,以确定有关匹配的更完整信息。 地理编码位置的置信度基于许多因素,包括地理编码位置和用户位置(如果指定)的相对重要性。 |
|
Country |
|
|
Error |
资源管理错误附加信息。 |
|
Error |
错误详细信息。 |
|
Error |
错误响应 |
|
Feature |
FeatureCollection 对象的类型必须是 FeatureCollection。 |
|
Features |
|
|
Feature |
特征的类型必须是功能。 |
|
Geocode |
一组地理编码点,这些点的计算方式及其建议的使用方式不同。 |
|
Geocoding |
此对象是从成功的地理编码调用返回的 |
|
Geo |
有效的 |
| Intersection |
结果的地址。 |
|
Match |
一个或多个匹配代码值,表示响应中每个位置的地理编码级别。 例如,具有匹配代码的地理编码位置 同样,具有匹配代码的地理编码位置 可能的值为:
|
| Properties | |
|
Reverse |
指定响应中所需的实体类型。 仅返回指定的类型。 如果点无法映射到指定的实体类型,则响应中不会返回位置信息。 默认值是所有可能的实体。 从以下选项中选择的实体类型的逗号分隔列表。
这些实体类型从最具体的实体排序到最不具体的实体。 当找到多个实体类型的实体时,仅返回最具体的实体。 例如,如果将 Address 和 AdminDistrict1 指定为两种类型的实体类型和实体,则响应中仅返回 Address 实体信息。 |
|
Usage |
最适合地理编码点。
每个地理编码点都定义为 |
Address
结果的地址
| 名称 | 类型 | 说明 |
|---|---|---|
| addressLine |
string |
包含街道名称和号码的 AddressLine |
| adminDistricts |
地址所在国家或地区的细分名称。 此元素通常被视为第一个顺序管理细分,但在某些情况下,它还包含国家/地区、依赖项或区域的第二、第三或第四个顺序细分。 |
|
| countryRegion | ||
| formattedAddress |
string |
Formatted Address 属性 |
| intersection |
结果的地址。 |
|
| locality |
string |
locality 属性 |
| neighborhood |
string |
neighborhood 属性 |
| postalCode |
string |
邮政编码属性 |
| streetName |
string |
formattedAddress 中的街道名称 |
| streetNumber |
string |
街道上的号码(如果可用),来自 formattedAddress |
AdminDistricts
地址所在国家或地区的细分名称。 此元素通常被视为第一个顺序管理细分,但在某些情况下,它还包含国家/地区、依赖项或区域的第二、第三或第四个顺序细分。
| 名称 | 类型 | 说明 |
|---|---|---|
| name |
string |
相应 adminDistrict 字段的名称,对于 adminDistrict[0],这可能是州的完整名称,例如华盛顿,对于 adminDistrict[1],这可能是该县的全名 |
| shortName |
string |
相应 adminDistrict 字段的短名称,对于 adminDistrict[0],这可能是州名称的短名称,例如 WA,对于 adminDistrict[1],这可能是县的短名称 |
CalculationMethodEnum
用于计算地理编码点的方法。
| 值 | 说明 |
|---|---|
| Interpolation |
使用插值将地理编码点与道路上的点进行匹配。 |
| InterpolationOffset |
地理编码点使用插值与道路上的点进行匹配,并使用额外的偏移量将点移动到街道一侧。 |
| Parcel |
地理编码点已与宗地中心匹配。 |
| Rooftop |
地理编码点与建筑物的屋顶匹配。 |
ConfidenceEnum
地理编码位置结果匹配的置信度级别。 将此值与匹配代码一起使用,以确定有关匹配的更完整信息。
地理编码位置的置信度基于许多因素,包括地理编码位置和用户位置(如果指定)的相对重要性。
| 值 | 说明 |
|---|---|
| High |
如果置信度设置为 如果请求包含位置或视图,则排名可能会相应更改。 例如,对“Paris”的位置查询会可靠地 |
| Medium |
在某些情况下,返回的匹配项可能与请求中提供的信息不在同一级别。 例如,请求可以指定地址信息,而地理编码服务可能只能匹配邮政编码。 在这种情况下,如果地理编码服务具有邮政编码与数据匹配的置信度,则置信度设置为 , 如果查询中的位置信息不明确,并且没有其他信息来对位置进行排名(例如用户位置或位置的相对重要性),则置信度设置为 如果查询中的位置信息未提供足够的信息来对特定位置进行地理编码,则可能会返回不太精确的位置值,并将置信度设置为 |
| Low |
CountryRegion
| 名称 | 类型 | 说明 |
|---|---|---|
| ISO |
string |
国家/地区的 ISO |
| name |
string |
国家/地区的名称 |
ErrorAdditionalInfo
资源管理错误附加信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| info |
object |
其他信息。 |
| type |
string |
其他信息类型。 |
ErrorDetail
错误详细信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| additionalInfo |
错误附加信息。 |
|
| code |
string |
错误代码。 |
| details |
错误详细信息。 |
|
| message |
string |
错误消息。 |
| target |
string |
错误目标。 |
ErrorResponse
错误响应
| 名称 | 类型 | 说明 |
|---|---|---|
| error |
错误对象。 |
FeatureCollectionEnum
FeatureCollection 对象的类型必须是 FeatureCollection。
| 值 | 说明 |
|---|---|
| FeatureCollection |
FeaturesItem
| 名称 | 类型 | 说明 |
|---|---|---|
| bbox |
number[] (double) |
边界框。 使用的投影 - EPSG:3857。 有关详细信息,请参阅 RFC 7946。 |
| geometry |
有效的 |
|
| id |
string |
返回的功能的 ID |
| properties | ||
| type |
特征的类型必须是功能。 |
FeatureTypeEnum
特征的类型必须是功能。
| 值 | 说明 |
|---|---|
| Feature |
GeocodePoints
一组地理编码点,这些点的计算方式及其建议的使用方式不同。
| 名称 | 类型 | 说明 |
|---|---|---|
| calculationMethod |
用于计算地理编码点的方法。 |
|
| geometry |
有效的 |
|
| usageTypes |
最适合地理编码点。
每个地理编码点都定义为 |
GeocodingResponse
此对象是从成功的地理编码调用返回的
| 名称 | 类型 | 说明 |
|---|---|---|
| features | ||
| nextLink |
string |
该链接指向返回的功能的下一页。 如果是最后一页,则不显示此字段。 |
| type |
FeatureCollection 对象的类型必须是 FeatureCollection。 |
GeoJsonPoint
有效的 GeoJSON Point 几何图形类型。 有关详细信息,请参阅 RFC 7946。
| 名称 | 类型 | 说明 |
|---|---|---|
| bbox |
number[] (double) |
边界框。 使用的投影 - EPSG:3857。 有关详细信息,请参阅 RFC 7946。 |
| coordinates |
number[] (double) |
|
| type |
string:
Point |
指定 |
Intersection
结果的地址。
| 名称 | 类型 | 说明 |
|---|---|---|
| baseStreet |
string |
该位置的主要街道。 |
| displayName |
string |
交集的完整名称。 |
| intersectionType |
string |
交集的类型。 |
| secondaryStreet1 |
string |
第一条相交的街道。 |
| secondaryStreet2 |
string |
如果有,第二条相交的街道。 |
MatchCodesEnum
一个或多个匹配代码值,表示响应中每个位置的地理编码级别。
例如,具有匹配代码的地理编码位置 Good 和 Ambiguous 意味着为位置信息找到了多个地理编码位置,并且地理编码服务没有搜索向上层次结构来查找匹配项。
同样,具有匹配代码的地理编码位置 Ambiguous 和 UpHierarchy 意味着找不到与提供的所有位置信息匹配的地理编码位置,因此地理编码服务必须搜索层次结构并在该级别找到多个匹配项。
Ambiguous 和 UpHierarchy 结果的一个示例是提供完整的地址信息,但地理编码服务找不到街道地址的匹配项,而是返回多个 RoadBlock 值的信息。
可能的值为:
Good:该位置只有一个匹配项或所有返回的匹配项被视为强匹配项。 例如,纽约的查询返回多个 Good 匹配项。
Ambiguous:位置是一组可能的匹配项之一。 例如,在查询街道地址 128 Main St.时,响应可能会返回 128 北主街和 128 南主街的两个位置,因为没有足够的信息来确定要选择的选项。
UpHierarchy:位置表示向上移动的地理层次结构。 如果未找到位置请求的匹配项,则会发生这种情况,因此会返回不太精确的结果。 例如,如果找不到所请求地址的匹配项,则可能会返回具有 RoadBlock 实体类型的 UpHierarchy 匹配代码。
| 值 | 说明 |
|---|---|
| Good | |
| Ambiguous | |
| UpHierarchy |
Properties
| 名称 | 类型 | 说明 |
|---|---|---|
| address |
结果的地址 |
|
| confidence |
地理编码位置结果匹配的置信度级别。 将此值与匹配代码一起使用,以确定有关匹配的更完整信息。 地理编码位置的置信度基于许多因素,包括地理编码位置和用户位置(如果指定)的相对重要性。 |
|
| geocodePoints |
一组地理编码点,这些点的计算方式及其建议的使用方式不同。 |
|
| matchCodes |
一个或多个匹配代码值,表示响应中每个位置的地理编码级别。 例如,具有匹配代码的地理编码位置 同样,具有匹配代码的地理编码位置 可能的值为:
|
|
| type |
string |
下列其中一项:
|
ReverseGeocodingResultTypeEnum
指定响应中所需的实体类型。 仅返回指定的类型。 如果点无法映射到指定的实体类型,则响应中不会返回位置信息。 默认值是所有可能的实体。 从以下选项中选择的实体类型的逗号分隔列表。
- 地址
- 附近
- PopulatedPlace
- Postcode1
- AdminDivision1
- AdminDivision2
- CountryRegion
这些实体类型从最具体的实体排序到最不具体的实体。 当找到多个实体类型的实体时,仅返回最具体的实体。 例如,如果将 Address 和 AdminDistrict1 指定为两种类型的实体类型和实体,则响应中仅返回 Address 实体信息。
| 值 | 说明 |
|---|---|
| Address | |
| Neighborhood | |
| PopulatedPlace | |
| Postcode1 | |
| AdminDivision1 | |
| AdminDivision2 | |
| CountryRegion |
UsageTypeEnum
最适合地理编码点。
每个地理编码点都定义为 Route 点、Display 点或两者。
如果要创建指向位置的路由,请使用 Route 点。 如果在地图上显示位置,请使用 Display 点。 例如,如果位置是公园,Route 点可以指定公园的入口,可以使用汽车进入,而 Display 点可能是指定公园中心点。
| 值 | 说明 |
|---|---|
| Display | |
| Route |