Search - Get Search Address Reverse

服务:

Maps

API 版本:

1.0

用于从纬度和经度坐标获取街道地址和位置信息。

Get Search Address Reverse API 是 HTTP GET 请求，当给定的纬度和经度坐标时返回街道地址或位置。

有时可能需要将坐标（例如：37.786505、-122.3862）转换为人类可理解的街道地址。 通常，在跟踪从设备或资产接收 GPS 源并想要知道坐标所在的地址的应用程序中，这通常需要这样做。 此终结点将返回给定坐标的地址信息。

GET https://atlas.microsoft.com/search/address/reverse/{format}?api-version=1.0&query={query}

具有可选参数:

GET https://atlas.microsoft.com/search/address/reverse/{format}?api-version=1.0&query={query}&language={language}&returnSpeedLimit={returnSpeedLimit}&heading={heading}&radius={radius}&number={number}&returnRoadUse={returnRoadUse}&roadUse={roadUse}&allowFreeformNewline={allowFreeformNewline}&returnMatchType={returnMatchType}&entityType={entityType}&view={view}

URI 参数

名称	在	必需	类型	说明
format	path	True	ResponseFormat	响应的所需格式。 值可以是 json ，也可以是 xml 。
api-version	query	True	string	Azure Maps API 的版本号。
query	query	True	number[]	指定为逗号分隔字符串的适用查询，后跟经度，例如“47.641268，-122.125679”。
allowFreeformNewline	query		boolean	格式地址中的换行符。 如果为 true，则地址将包含换行符。 如果为 false，则换行符将转换为逗号。
entityType	query		GeographicEntityType	指定对地理区域执行的筛选级别。 缩小对指定地理实体类型的搜索范围，例如仅返回城市。 生成的响应将包含地理 ID 以及匹配的实体类型。 如果将多个实体作为逗号分隔列表提供，终结点将返回“可用的最小实体”。 返回的几何图形 ID 可用于通过 获取搜索多边形 API 获取该地理的几何图形。 设置 entityType 时，将忽略以下参数： 标题 数字 returnRoad使用 returnSpeedLimit 道路使用 returnMatchType
heading	query		integer minimum: -360 maximum: 360	车辆方向方向（以度为单位）沿一段公路行驶。 0 为 North，90 为 East 等，值范围从 -360 到 360。 精度最多可以包含一个小数位数
language	query		string	应返回搜索结果的语言。 应该是受支持的 IETF 语言标记之一，不区分大小写。 当指定语言中的数据不适用于特定字段时，将使用默认语言。 有关详细信息，请参阅 支持的语言。
number	query		string	作为字符串的街道编号。 如果数字随请求一起发送，则响应可能包括街道（左/右）的一侧，以及该数字的偏移位置
radius	query		integer	结果限制为定义的区域的半径（以米为单位）
returnMatchType	query		boolean	包括有关响应中实现的地理编码器匹配类型的信息。
returnRoadUse	query		boolean	布尔值。 为街道级别的反向地理编码启用道路使用数组的返回
returnSpeedLimit	query		boolean	布尔值。 启用发布速度限制的返回
roadUse	query		RoadUseType[]	将反向地理编码限制为某种类型的道路使用。 反向地理编码的道路使用数组可以是一个或多个 LimitedAccess、动脉、终端、坡道、旋转、LocalStreet
view	query		LocalizedMapView	View 参数（也称为“用户区域”参数）允许为地缘政治争议区域显示特定国家/地区的正确地图。 不同的国家/地区具有此类区域的不同视图，并且 View 参数允许应用程序符合应用程序将提供服务的国家/地区所需的视图。 默认情况下，即使尚未在请求中定义该参数，View 参数也会设置为“Unified”。 由你负责确定用户的位置，然后为该位置正确设置 View 参数。 或者，可以选择设置“View=Auto”，这将基于请求的 IP 地址返回地图数据。 Azure Maps 中的 View 参数必须符合适用法律，包括地图、图像和其他数据以及你有权通过 Azure Maps 访问的国家/地区的地图、图像和其他数据和第三方内容。 示例：view=IN。 有关详细信息，请参阅 支持的视图，并查看可用的视图。

请求头

名称	必需	类型	说明
x-ms-client-id		string	指定哪个帐户与 Microsoft Entra ID 安全模型结合使用。 它表示 Azure Maps 帐户的唯一 ID，可以从 Azure Maps 管理平面帐户 API 检索。 若要在 Azure Maps 中使用 Microsoft Entra ID 安全性，请参阅以下 文章 以获取指导。

响应

名称	类型	说明
200 OK	ReverseSearchAddressResult	还行
Other Status Codes	ErrorResponse	发生意外错误。

安全性

AADToken

这些 Microsoft Entra OAuth 2.0 流。 与 Azure 基于角色的访问配对时， 控制它可用于控制对 Azure Maps REST API 的访问。 Azure 基于角色的访问控制用于指定对一个或多个 Azure Maps 资源帐户或子资源的访问。 任何用户、组或服务主体都可以通过内置角色或由一个或多个对 Azure Maps REST API 的权限组成的自定义角色授予访问权限。

若要实现方案，建议查看 身份验证概念。 总之，此安全定义提供了一种解决方案，用于通过能够针对特定 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 Maps 帐户 时预配的共享密钥。

使用此密钥，任何应用程序都可以访问所有 REST API。 换句话说，此密钥可用作颁发密钥的帐户中的主密钥。

对于公开的应用程序，我们建议使用 机密客户端应用程序 方法来访问 Azure Maps REST API，以便安全地存储密钥。

类型: apiKey
在: query

SAS Token

这是一个共享访问签名令牌，它通过 Azure 门户、PowerShell、CLI、Azure SDK 或 REST API 通过 Azure 管理平面在 azure Maps 资源 上的列表 SAS 操作创建。

使用此令牌，任何应用程序都有权使用 Azure 基于角色的访问控制进行访问，并精细控制特定令牌的过期、速率和区域。 换句话说，SAS 令牌可用于允许应用程序以比共享密钥更安全的方式控制访问。

对于公开的应用程序，建议在 映射帐户资源 上配置允许的源的特定列表，以限制呈现滥用并定期续订 SAS 令牌。

类型: apiKey
在: header

示例

Searches addresses for coordinates 37.337,-121.89

示例请求

HTTP

GET https://atlas.microsoft.com/search/address/reverse/json?api-version=1.0&query=37.337,-121.89

示例响应

状态代码:

200

{
  "summary": {
    "queryTime": 5,
    "numResults": 1
  },
  "addresses": [
    {
      "address": {
        "streetNumber": "31",
        "routeNumbers": [],
        "streetName": "N 2nd St",
        "streetNameAndNumber": "31 N 2nd St",
        "countryCode": "US",
        "countrySubdivisionCode": "CA",
        "countrySubdivisionName": "California",
        "municipality": "San Jose",
        "postalCode": "95113",
        "country": "United States of America",
        "countryCodeISO3": "USA",
        "freeformAddress": "31 N 2nd St, San Jose CA 95113",
        "extendedPostalCode": "951131217"
      },
      "position": "37.337090,-121.889820"
    }
  ]
}

定义

名称	说明
Address	结果的地址
BoundingBoxCompassNotation	位置的边界框。
Entity	边界框的实体类型源。 对于反向地理编码，这始终等于位置。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
GeographicEntityType	地理实体类型。 仅当请求了 entityType 且可用时才存在。
LatLongPairAbbreviated	用短名称“lat”&“lon”表示为纬度和经度的位置。
LocalizedMapView	View 参数（也称为“用户区域”参数）允许为地缘政治争议区域显示特定国家/地区的正确地图。 不同的国家/地区具有此类区域的不同视图，并且 View 参数允许应用程序符合应用程序将提供服务的国家/地区所需的视图。 默认情况下，即使尚未在请求中定义该参数，View 参数也会设置为“Unified”。 由你负责确定用户的位置，然后为该位置正确设置 View 参数。 或者，可以选择设置“View=Auto”，这将基于请求的 IP 地址返回地图数据。 Azure Maps 中的 View 参数必须符合适用法律，包括地图、图像和其他数据以及你有权通过 Azure Maps 访问的国家/地区的地图、图像和其他数据和第三方内容。 示例：view=IN。 有关详细信息，请参阅 支持的视图，并查看可用的视图。
MatchType	反向地址搜索作的匹配类型。
QueryType	要返回的查询类型：NEARBY 或 NON_NEAR。
ResponseFormat	响应的所需格式。 值可以是 json ，也可以是 xml 。
ReverseSearchAddressResult	此对象是从成功的搜索地址反向调用返回的
ReverseSearchAddressResultItem	搜索地址反向响应的结果对象
RoadUseType	描述道路的可能用途。
SearchSummary	搜索 API 响应的摘要对象。

Address

Object

结果的地址

名称	类型	说明
boundingBox	BoundingBoxCompassNotation	位置的边界框。
buildingNumber	string	街上的建筑号。 已弃用，请改用 streetNumber。
country	string	国家/地区名称
countryCode	string	国家/地区（注意：这是一个双字母代码，而不是国家/地区名称）。
countryCodeISO3	string	ISO alpha-3 国家/地区代码
countrySecondarySubdivision	string	县
countrySubdivision	string	州或省
countrySubdivisionCode	string	countrySubdivisionCode 以 countryCode（countryCode-countrySubdivisionCode）和连字符作为前缀，构成 ISO 3166-2 代码。 示例：TX for Texas、SCT for 苏格兰和 ON for On on for On。
countrySubdivisionName	string	第一级国家/地区管理层次结构的全名。 仅当 countrySubdivision 以缩写形式显示时，才会显示此字段。 仅支持美国、加拿大和英国。
countryTertiarySubdivision	string	命名区域
crossStreet	string	要交叉的街道的名称。
extendedPostalCode	string	扩展邮政编码（可用性取决于区域）。
freeformAddress	string	根据结果所在国家/地区的格式规则设置格式的地址行，或者在国家/地区的情况下，其完整国家/地区名称。
localName	string	一个地址组件，表示地理区域或区域的名称，用于对多个可寻址对象进行分组以实现寻址目的，而不用作管理单元。 此字段用于生成 freeformAddress 属性。 localName 表示邮政城市。 根据位置，localName 是城市或城镇的已知名称。 对于城市或城镇的已知名称，请使用 localName 而不是 municipality。
municipality	string	城市/城镇 注意：municipality 表示住宅城市。 根据位置，municipality 值可能与城市或城镇的已知名称不同。 对于城市或城镇的已知名称，建议使用 localName 值而不是 municipality 值。
municipalitySubdivision	string	Sub /Super City
neighbourhood	string	邻里是城市或城镇的地理本地化区域，具有鲜明的特点和居民之间的社会互动。
postalCode	string	邮政编码/邮政编码
routeNumbers	string[]	用于明确标识街道的代码
street	string	街道名称。 已弃用，请改用 streetName。
streetName	string	街道名称。
streetNameAndNumber	string	街道名称和编号。
streetNumber	string	街上的建筑号。

BoundingBoxCompassNotation

Object

位置的边界框。

名称	类型	说明
entity	Entity	边界框的实体类型源。 对于反向地理编码，这始终等于位置。
northEast	string	以逗号分隔的浮点形式的边界框的东北纬度、经度坐标
southWest	string	以逗号分隔的浮点数形式表示边界框的西南纬度、经度坐标

Entity

枚举

边界框的实体类型源。 对于反向地理编码，这始终等于位置。

值	说明
position	位置实体

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

GeographicEntityType

枚举

地理实体类型。 仅当请求了 entityType 且可用时才存在。

值	说明
Country	国家/地区名称
CountrySecondarySubdivision	县
CountrySubdivision	州或省
CountryTertiarySubdivision	命名区域
Municipality	城市/城镇
MunicipalitySubdivision	Sub /Super City
Neighbourhood	附近
PostalCodeArea	邮政编码/邮政编码

LatLongPairAbbreviated

Object

用短名称“lat”&“lon”表示为纬度和经度的位置。

名称	类型	说明
lat	number (double)	Latitude 属性
lon	number (double)	经度属性

LocalizedMapView

枚举

View 参数（也称为“用户区域”参数）允许为地缘政治争议区域显示特定国家/地区的正确地图。 不同的国家/地区具有此类区域的不同视图，并且 View 参数允许应用程序符合应用程序将提供服务的国家/地区所需的视图。 默认情况下，即使尚未在请求中定义该参数，View 参数也会设置为“Unified”。 由你负责确定用户的位置，然后为该位置正确设置 View 参数。 或者，可以选择设置“View=Auto”，这将基于请求的 IP 地址返回地图数据。 Azure Maps 中的 View 参数必须符合适用法律，包括地图、图像和其他数据以及你有权通过 Azure Maps 访问的国家/地区的地图、图像和其他数据和第三方内容。 示例：view=IN。

有关详细信息，请参阅 支持的视图，并查看可用的视图。

值	说明
AE	阿拉伯联合酋长国（阿拉伯语视图）
AR	阿根廷 （阿根廷视图）
Auto	根据请求的 IP 地址返回映射数据。
BH	巴林 （阿拉伯语视图）
IN	印度 （印度视图）
IQ	伊拉克 （阿拉伯语视图）
JO	约旦 （阿拉伯语视图）
KW	科威特 （阿拉伯语视图）
LB	黎巴嫩 （阿拉伯语视图）
MA	摩洛哥 （摩洛哥视图）
OM	阿曼 （阿拉伯语视图）
PK	巴基斯坦（巴基斯坦观点）
PS	巴勒斯坦民族权力机构（阿拉伯语视图）
QA	卡塔尔 （阿拉伯语视图）
SA	沙特阿拉伯 （阿拉伯语视图）
SY	叙利亚 （阿拉伯语视图）
Unified	统一视图 （其他）
YE	也门 （阿拉伯语视图）

MatchType

枚举

反向地址搜索作的匹配类型。

值	说明
AddressPoint
HouseNumberRange
Street

QueryType

枚举

要返回的查询类型：NEARBY 或 NON_NEAR。

值	说明
NEARBY	搜索是在具有定义半径的特定纬度和经度周围执行的
NON_NEAR	搜索全局执行，不偏向特定纬度和经度，且未定义半径

ResponseFormat

枚举

响应的所需格式。 值可以是 json ，也可以是 xml 。

值	说明
json	JavaScript 对象表示法数据交换格式
xml	可扩展标记语言

ReverseSearchAddressResult

Object

此对象是从成功的搜索地址反向调用返回的

名称	类型	说明
addresses	ReverseSearchAddressResultItem[]	地址数组
summary	SearchSummary	搜索地址反向响应的摘要对象

ReverseSearchAddressResultItem

Object

搜索地址反向响应的结果对象

名称	类型	说明
address	Address	结果的地址
matchType	MatchType	有关匹配类型的信息。 下列其中一项： 地址点 HouseNumberRange 街道
position	string	Position 属性的格式为“{latitude}，{longitude}”
roadUse	RoadUseType[]	描述道路的可能用途。

RoadUseType

枚举

描述道路的可能用途。

值	说明
Arterial
LimitedAccess
LocalStreet
Ramp
Rotary
Terminal

SearchSummary

Object

搜索 API 响应的摘要对象。

名称	类型	说明
fuzzyLevel	integer	提供结果所需的最大模糊级别。
geoBias	LatLongPairAbbreviated	指示内部搜索引擎何时应用地理空间偏差来提高结果排名。 在某些方法中，这可以通过设置 lat 和 lon 参数（如果可用）而受到影响。 在其他情况下，它纯粹是内部的。
limit	integer	将返回的最大响应数
numResults	integer	响应中的结果数。
offset	integer	完整结果集中返回的结果的起始偏移量。
query	string	用于生成这些搜索结果的查询参数。
queryTime	integer	解析查询所用的时间（以毫秒为单位）。
queryType	QueryType	要返回的查询类型：NEARBY 或 NON_NEAR。
totalResults	integer	找到的结果总数。