Search - Get Reverse Geocoding
Используется для получения адреса улицы и информации о местоположении по координатам долготы и широты.
API Get Reverse Geocoding — это запрос HTTP GET, используемый для перевода координат (например, 37.786505, -122.3862) в понятный почтовый адрес человека. Полезно в отслеживании приложений, где вы получаете GPS-канал от устройства или ресурса и хотите знать адрес, связанный с координатами. Эта конечная точка вернет сведения об адресе для заданной координаты.
GET {endpoint}/reverseGeocode?api-version=2026-01-01&coordinates={coordinates}
GET {endpoint}/reverseGeocode?api-version=2026-01-01&coordinates={coordinates}&resultTypes={resultTypes}&view={view}
Параметры URI
| Имя | В | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
Hostname сервиса Azure Maps. Используйте |
|
api-version
|
query | True |
string minLength: 1 |
Версия API, используемая для данной операции. |
|
coordinates
|
query | True |
number[] |
Координаты расположения, которое требуется отменить геокод. Пример: координаты &=lon,lat |
|
result
|
query |
Укажите типы сущностей, которые требуется в ответе. Будут возвращены только указанные типы. Если точка не может быть сопоставлена с указанными типами сущностей, в ответе не возвращаются сведения о расположении. Значение по умолчанию — это все возможные сущности. Разделенный запятыми список типов сущностей, выбранных из следующих параметров.
Эти типы сущностей упорядочены из наиболее конкретной сущности в наименьшую конкретную сущность. При обнаружении сущностей нескольких типов сущностей возвращается только самая конкретная сущность. Например, если вы указали Address и AdminDistrict1 как типы сущностей и сущности для обоих типов, в ответе возвращаются только сведения об сущности Address. |
||
|
view
|
query |
string |
Строка, представляющая код региона илистраны ISO 3166-1 Альфа-2. Это изменит геополитические спорные границы и метки, чтобы выровняться с указанным регионом пользователя. По умолчанию параметр View имеет значение Auto, даже если он не определен в запросе. Дополнительные сведения о доступных представлениях см. в поддерживаемых представлений. |
Заголовок запроса
| Имя | Обязательно | Тип | Описание |
|---|---|---|---|
| x-ms-client-id |
string |
Указывает, какой аккаунт предназначен для использования в сочетании с моделью безопасности Azure AD. Он представляет собой уникальный идентификатор для аккаунта Azure Maps и может быть извлечен из API управления плоскостью Azure Maps Account API. Для получения дополнительной информации об использовании Microsoft Entra ID безопасности в Azure Maps см. раздел Управление аутентификацией в Azure Maps. |
|
| Accept-Language |
string |
Язык, в котором должны быть возвращены результаты поиска. Дополнительные сведения см. в поддерживаемых языках. |
Ответы
| Имя | Тип | Описание |
|---|---|---|
| 200 OK |
Запрос выполнен успешно. Media Types: "application/geo+json", "application/json" |
|
| Other Status Codes |
Непредвиденное сообщение об ошибке. Media Types: "application/geo+json", "application/json" Заголовки x-ms-error-code: string |
Безопасность
AadToken
Это Microsoft Entra OAuth 2.0 потоки. В сочетании с управлением Azure ролевым доступом он может использоваться для управления доступом к Azure Maps REST API. Ролевые контроли доступа Azure используются для обозначения доступа к одной или нескольким учетной записи ресурсов или подресурсам Azure Maps. Доступ к любому пользователю, группе или субъекту-службе можно предоставить через встроенную роль или пользовательскую роль, состоящую из одного или нескольких разрешений для REST API Azure Maps.
Для реализации сценариев рекомендуется просматривать концепции проверки подлинности . В целом, это определение безопасности предоставляет решение для моделирования приложений через объекты, способные управлять доступом в определенных API и областях.
Note
- Для этого определения безопасности требуется использовать заголовок
x-ms-client-id, чтобы указать, к какой ресурсу Azure Maps приложение запрашивает доступ. Это можно получить изAPI управления картами. -
Authorization URLзависит от экземпляра общедоступного облака Azure. Облака Sovereign имеют уникальные URL-адреса авторизации и конфигурации Microsoft Entra ID. - Управление доступом на основе ролей Azure настраивается на основе плоскости управления Azure с помощью портала Azure, PowerShell, CLI, пакетов SDK Azure или REST API.
- Использование веб-пакета SDK для Azure Maps
позволяет настроить приложение на основе конфигурации для нескольких вариантов использования. - Дополнительные сведения о платформе удостоверений Майкрософт см. в обзоре платформы удостоверений Майкрософт.
Тип:
oauth2
Flow:
implicit
URL-адрес авторизации:
https://login.microsoftonline.com/common/oauth2/authorize
Области
| Имя | Описание |
|---|---|
| https://atlas.microsoft.com/.default |
subscription-key
Это общий ключ, подготовленный при создания учетной записи Azure Maps на портале Azure или с помощью PowerShell, CLI, пакетов SDK Azure или REST API.
С помощью этого ключа любой приложение может получить доступ ко всем REST API. Другими словами, этот ключ можно использовать в качестве главного ключа в учетной записи, в которую они выданы.
Для общедоступных приложений мы рекомендуем использовать конфиденциальные клиентские приложения, подход для доступа к REST API Azure Maps, чтобы ваш ключ можно было безопасно хранить.
Тип:
apiKey
В:
header
SAS Token
Это маркер подписанного URL-адреса создается из операции SAS списка на ресурсе Azure Maps через плоскость управления Azure с помощью портала Azure, PowerShell, CLI, пакетов SDK Azure или REST API.
С помощью этого маркера любой приложению разрешен доступ с помощью управления доступом на основе ролей Azure и точного управления сроком действия, скоростью и регионами, используемыми для конкретного маркера. Другими словами, маркер SAS можно использовать для разрешения приложений управлять доступом более защищенным способом, чем общий ключ.
Для общедоступных приложений мы рекомендуем настроить определенный список разрешенных источников в ресурсе учетной записи карты карты, чтобы ограничить злоупотребление отрисовкой и регулярно обновлять маркер SAS.
Тип:
apiKey
В:
header
Примеры
Search point -122.138681, 47.630358
Образец запроса
GET https://atlas.microsoft.com/reverseGeocode?api-version=2026-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 |
Адрес геокодированного или автозаполнения предполагаемого местоположения, разобранный в структурированные поля.
Редкость нормальна: заполнены только поля, которые предоставляет решённая сущность. Например |
|
Address |
Административное подразделение, содержащее адрес. Например, штат, провинция или округ. Возвращается как одна запись в родительском |
|
Address |
Страна или регион, содержащий адрес, идентифицируется по отображённому именю и коду страны ISO 3166-1 Alpha-2. Любое поле может быть опущено в конкретном ответе. |
|
Azure. |
Объект ошибки. |
|
Azure. |
Ответ, содержащий сведения об ошибке. |
|
Azure. |
Объект, содержащий более конкретные сведения об ошибке. Согласно Azure рекомендациям REST API — https://aka.ms/AzureRestApiGuidelines#handling-errors. |
|
Calculation |
Метод, используемый для вычисления точки геокода. |
|
Confidence |
Уровень уверенности, что результат географического расположения соответствует. Используйте это значение вместе с кодами совпадения, чтобы получить более полную информацию о матче. Достоверность геокодированного места основана на множестве факторов, включая относительную важность геокодированного местоположения и местоположение пользователя, если оно указано. |
|
Feature |
Тип объекта, |
|
Features |
Одна запись в |
|
Features |
Полезная |
|
Feature |
Тип |
|
Geocode |
Одна точка геокода для местоположения: координата плюс метаданные, описывающие, как была вычислена точка ( |
|
Geocoding |
Тело успешного ответа возвращалось по |
|
Geo |
Указывает тип |
|
Geo |
Допустимый тип геометрии |
| Intersection |
Детали перекрёстка для адреса, определяемого как дорожное пересечение — угол, где встречаются две или более названных улиц. Заполняется только тогда, когда разрешённая сущность — ; |
|
Match |
Значение кода соответствия, указывающее, как сервис геокодирования дал конкретный результат местоположения. Поле |
|
Reverse |
Тип сущности, возвращаемый |
|
Usage |
Предполагаемое использование точки геокода. Геокодовая точка, возвращаемая сервисом, несёт один или несколько типов использования, которые указывают, как клиентское приложение должно потреблять эту точку: например, отображение местоположения на карте против маршрутизации транспортного средства к ней. |
Address
Адрес геокодированного или автозаполнения предполагаемого местоположения, разобранный в структурированные поля.
Редкость нормальна: заполнены только поля, которые предоставляет решённая сущность. Например streetName , и streetNumber отображаются только для адресов на уровне улицы и intersection только для результатов дорожных перекрёстков.
| Имя | Тип | Описание |
|---|---|---|
| addressLine |
string |
Первая строка адреса, обычно название и номер улицы. Например: |
| adminDistricts |
Административные подразделения, содержащие адрес, упорядочены от самого грубого к лучшему. Первая запись обычно относится к подразделению первого порядка (например, в штате США или канадской провинции); Последующие записи охватывают более тонкие подразделения, где их определяет страна, зависимость или регион (например, округ с индексом 1). |
|
| countryRegion |
Страна или регион, содержащий адрес, с его отображаемым именем и кодом страны ISO 3166-1 Alpha-2. |
|
| formattedAddress |
string |
Полный адрес отображался как одна строка, читаемая человеком, с компонентами, объединёнными в соответствии с конвенциями страны или региона адреса. Пример: |
| intersection |
Детали пересекающихся улиц для адреса, заполняются, когда разрешаемая сущность — a |
|
| locality |
string |
Местность, в которую находится адрес: обычно город, посёлок или деревня. Например: |
| neighborhood |
string |
Названный район внутри местности, когда он идентифицирован. |
| postalCode |
string |
Почтовый индекс адреса, когда он определен. Пример: |
| streetName |
string |
Компонент названия улицы в адресе, когда решённая сущность является адресом на уровне улицы. Пример: |
| streetNumber |
string |
Номер дома или здания на улице, когда решённое лицо — адрес на уровне улицы. Пример: |
AddressAdminDistrictsItem
Административное подразделение, содержащее адрес. Например, штат, провинция или округ. Возвращается как одна запись в родительском Address.adminDistricts массиве, где записи упорядочены от самых крупных к мельчайшим.
| Имя | Тип | Описание |
|---|---|---|
| name |
string |
Полное название района. Например, |
| shortName |
string |
Короткая или сокращённая форма названия подразделения, когда оно определено. Например, |
AddressCountryRegion
Страна или регион, содержащий адрес, идентифицируется по отображённому именю и коду страны ISO 3166-1 Alpha-2. Любое поле может быть опущено в конкретном ответе.
| Имя | Тип | Описание |
|---|---|---|
| ISO |
string |
Код страны ISO 3166-1 Alpha-2 для страны или региона. Например, |
| name |
string |
Отображаемое название страны или региона. Например: |
Azure.Core.Foundations.Error
Объект ошибки.
| Имя | Тип | Описание |
|---|---|---|
| code |
string |
Один из определяемых сервером кодов ошибок. |
| details |
Массив сведений об определенных ошибках, которые привели к этой сообщаемой ошибке. |
|
| innererror |
Объект, содержащий более конкретные сведения, чем текущий объект об ошибке. |
|
| message |
string |
Читаемое пользователем представление ошибки. |
| target |
string |
Целевой объект ошибки. |
Azure.Core.Foundations.ErrorResponse
Ответ, содержащий сведения об ошибке.
| Имя | Тип | Описание |
|---|---|---|
| error |
Объект ошибки. |
Azure.Core.Foundations.InnerError
Объект, содержащий более конкретные сведения об ошибке. Согласно Azure рекомендациям REST API — https://aka.ms/AzureRestApiGuidelines#handling-errors.
| Имя | Тип | Описание |
|---|---|---|
| code |
string |
Один из определяемых сервером кодов ошибок. |
| innererror |
Внутренняя ошибка. |
CalculationMethodEnum
Метод, используемый для вычисления точки геокода.
| Значение | Описание |
|---|---|
| Interpolation |
Точка геокодирования была сопоставлена с точкой на дороге с помощью интерполяции. |
| InterpolationOffset |
Точка геокодирования была сопоставлена с точкой на дороге с помощью интерполяции с дополнительным смещением для смещения точки в сторону улицы. |
| Parcel |
Точка геокодирования была сопоставлена с центром участка. |
| Rooftop |
Точка геокодирования была сопоставлена с крышей здания. |
ConfidenceEnum
Уровень уверенности, что результат географического расположения соответствует. Используйте это значение вместе с кодами совпадения, чтобы получить более полную информацию о матче.
Достоверность геокодированного места основана на множестве факторов, включая относительную важность геокодированного местоположения и местоположение пользователя, если оно указано.
| Значение | Описание |
|---|---|
| High |
Если достоверность установлена на Если запрос содержит местоположение или вид, рейтинг может измениться соответственно. Например, запрос по локации «Paris» с уверенностью возвращает и «Paris, France», и «Paris, TX |
| Medium |
В некоторых ситуациях возвращенное совпадение может не совпадать с информацией, предоставленной в запросе. Например, в запросе может быть указана адресная информация, а служба геокодирования может сопоставить только почтовый индекс. В этом случае, если сервис геокода уверен, что почтовый индекс совпадает с данными, уверенность устанавливается на Если информация о расположении в запросе неоднозначна и нет дополнительных сведений для ранжирования местоположений (например, местоположения пользователя или относительная важность расположения), достоверность устанавливается в значение Если информация о местоположении в запросе не предоставляет достаточной информации для геокодирования конкретного местоположения, может быть возвращено менее точное значение местоположения, а достоверность устанавливается в |
| Low |
Низкая уверенность в матче. |
FeatureCollectionEnum
Тип объекта, GeoJSON используемый в основе успешных ответов при операциях прямого геокодирования, обратного геокодирования и автозаполнения (включая их пакетные варианты). Единственное значение — FeatureCollection, как определено в RFC 7946.
Get Polygon является единственным исключением: его корень ответа — GeoJSON Featureэто , см. FeatureTypeEnum.
| Значение | Описание |
|---|---|
| FeatureCollection |
Тип |
FeaturesItem
Одна запись в features массиве GeocodingResponse, соответствующая GeoJSON Feature форме объекта.
Представляет одну геокодированную точку: структурированные данные на properties, репрезентативную координату на geometry, и необязательный ограничивающий квадрат на bbox.
| Имя | Тип | Описание |
|---|---|---|
| bbox |
number[] (double) |
Самый маленький прямоугольник, выровненный по осям, содержащий геометрию объекта, в порядке WGS 84 по долготе/широте. Закодировано согласно |
| geometry |
Первичная |
|
| id |
string |
Опциональный идентификатор, присваиваемый сервисом, для этой функции, когда он доступен. |
| properties |
Структурированные данные о геокодированном месте, включая тип сущности, индикаторы качества соответствия, компоненты адреса и одну или несколько точек геокода. |
|
| type |
Тип |
FeaturesItemProperties
Полезная properties нагрузка объекта в GeocodingResponse. Несёт индикаторы типа сущности и качества соответствия для геокодированного местоположения, его проанализированных адресных компонентов и одной или нескольких точек геокода, закрепляющих местоположение с определёнными координатами.
| Имя | Тип | Описание |
|---|---|---|
| address |
Адрес геокодированного местоположения, разбитый по структурированным полям, таким как местность, почтовый индекс, страна/регион и (если доступно) название и номер улицы. |
|
| confidence |
Насколько сильно геокодированное местоположение соответствует запросу? Используйте вместе |
|
| geocodePoints |
Одна или несколько точек геокода для местоположения, каждая из которых отмечена, как она была получена ( |
|
| matchCodes |
Как сервис геокодирования дал такой результат относительно запроса: прямое совпадение по запрашиваемой специфичности ( |
|
| type |
string |
Тип объекта, к которому было разрешено геокодированное местоположение. Один из: , , , |
FeatureTypeEnum
Тип GeoJSON объекта для Feature объектов. Помечает каждую запись внутри features массива FeatureCollection ответа (геокодирование, обратное геокодирование, автодополнение) и появляется в корне Get Polygon ответа. Единственное значение — Feature, как определено в RFC 7946.
| Значение | Описание |
|---|---|
| Feature |
Тип |
GeocodePointsItem
Одна точка геокода для местоположения: координата плюс метаданные, описывающие, как была вычислена точка (calculationMethod) и для чего она лучше всего подходит (usageTypes). Одна функция обычно возвращает отдельные Display и Route указывают, чтобы звонящие могли выбрать ту, которая подходит для задачи.
| Имя | Тип | Описание |
|---|---|---|
| calculationMethod |
Как вычислялась эта точка. Например, прикреплён к крыше здания или интерполирован вдоль центральной линии дороги. См. |
|
| geometry |
Координата этого геокода указывает на |
|
| usageTypes |
Для того, для чего лучше всего подходит геокодовая точка: |
GeocodingResponse
Тело успешного ответа возвращалось по Get Geocoding и Get Reverse Geocoding, а форма успеха на каждой партии передавалась внутрь GeocodingBatchResponse.batchItems.
Кодируется как , GeoJSON FeatureCollection чей features массив содержит по Feature одному на каждое геокодированное место.
| Имя | Тип | Описание |
|---|---|---|
| features |
Массив |
|
| nextLink |
string |
Содержит URL для получения следующей страницы результатов, если ответ пагинирован. Это полезно, когда ответ слишком велик, чтобы его можно было вернуть за один вызов, позволяя пользователям перемещаться по нескольким страницам с результатами. |
| type |
Тип |
GeoJsonObjectType
Указывает тип GeoJSON. Должен быть одним из девяти допустимых типов объектов GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.
| Значение | Описание |
|---|---|
| Point |
|
| MultiPoint |
|
| LineString |
|
| MultiLineString |
|
| Polygon |
|
| MultiPolygon |
|
| GeometryCollection |
|
| Feature |
Объект |
| FeatureCollection |
Объект |
GeoJsonPoint
Допустимый тип геометрии GeoJSON Point. Дополнительные сведения см. в RFC 7946.
| Имя | Тип | Описание |
|---|---|---|
| bbox |
number[] (double) |
Ограничивающий прямоугольник. Используется проекция — EPSG:3857. Дополнительные сведения см. в RFC 7946. |
| coordinates |
number[] (double) |
|
| type |
string:
Point |
Указывает тип |
Intersection
Детали перекрёстка для адреса, определяемого как дорожное пересечение — угол, где встречаются две или более названных улиц. Заполняется только тогда, когда разрешённая сущность — ; RoadIntersectionродительский Address.intersection элемент в противном случае опускается.
| Имя | Тип | Описание |
|---|---|---|
| baseStreet |
string |
Главная улица перекрёстка — обычно улица, к которой указывает номер адреса. |
| displayName |
string |
Понятное человеком название перекрёстка, которое объединяет перекрёстки, например |
| intersectionType |
string |
Краткая маркировка, описывающая форму пересечения. Например, отличие перекрёстка на уровне от пересечения по уровням, такого как мост или эстакада. |
| secondaryStreet1 |
string |
Первая перекрёстная улица, которая сходится |
| secondaryStreet2 |
string |
Второй перекрёсток на перекрёстке, когда один из них присутствует. Населено только на пересечениях трёх и более улиц. |
MatchCodesEnum
Значение кода соответствия, указывающее, как сервис геокодирования дал конкретный результат местоположения. Поле matchCodes на признаке — это массив этих значений; объедините их с confidence и type для оценки качества совпадения.
| Значение | Описание |
|---|---|
| Good |
Сервис геокодирования произвел этот кандидат без расширения запроса: результат совпадает с запросом с запрошенной конкретностью. |
| Ambiguous |
Местоположение — одно из множества возможных совпадений. Например, при запросе по адресу улицы «128 Main St.» ответ может вернуть два адреса для «128 North Main St.» и «128 South Main St.», потому что информации недостаточно для выбора. |
| UpHierarchy |
Местоположение символизирует подъём по географической иерархии. Это происходит, когда совпадение для запроса расположения не найдено, поэтому возвращается менее точный результат. |
ReverseGeocodingResultTypeEnum
Тип сущности, возвращаемый Get Reverse Geocoding операцией. Предоставляется в виде одного или нескольких значений в resultTypes параметре запроса для ограничения ответа определёнными типами мест; когда параметр опущен, все типы сущностей становятся допустимыми. Когда сущности более одного типа совпадают с одной координатой, возвращается только самая конкретная. Перечислено от самых конкретных к наименее специфичным: Address, Neighborhood, CountryRegionAdminDivision2PopulatedPlacePostcode1AdminDivision1.
| Значение | Описание |
|---|---|
| Address |
Конкретный адрес. |
| Neighborhood |
Местно признанная территория внутри населённого пункта, часто с неформальными или культурно определёнными границами. |
| PopulatedPlace |
Концентрированная территория населенного пункта, такая как город, поселок или деревня. |
| Postcode1 |
Самая маленькая категория почтового индекса, например, почтовый индекс. |
| AdminDivision1 |
Первый административный уровень внутри страны/региона, например, штат или провинция. |
| AdminDivision2 |
Второй административный уровень внутри страны/региона, например, графство. |
| CountryRegion |
Страна или регион. |
UsageTypeEnum
Предполагаемое использование точки геокода. Геокодовая точка, возвращаемая сервисом, несёт один или несколько типов использования, которые указывают, как клиентское приложение должно потреблять эту точку: например, отображение местоположения на карте против маршрутизации транспортного средства к ней.
| Значение | Описание |
|---|---|
| Display |
Точка геокода подходит для отображения местоположения на карте. Для объектов с нетривиальными масштабами (например, парк или здание) |
| Route |
Точка геокода подходит для назначения маршрута. Для объектов с нетривиальными масштабами (например, парк или здание) |