Search - Get Geocoding
Используется для получения координат долготы и широты улицы, адреса или названия населенного пункта.
Get Geocoding API — это HTTP-запросGET, который возвращает координаты долготы и широты искомого местоположения.
Во многих случаях полная служба поиска может быть слишком много, например, если вы заинтересованы только в традиционном геокодирование. Поиск также можно получить только для поиска адресов. Геокодирование выполняется путем нажатия на конечную точку геокодирования только с рассматриваемым адресом или частичным адресом. Индекс поиска геокодирования будет запрашиваться для всех данных над данными уровня улицы. Точки интереса (POI) не возвращаются. Обратите внимание, что геокодер очень терпим к опечаткам и неполным адресам. Он также будет обрабатывать все, начиная от точных адресов улиц, улиц или перекрестков, а также географических регионов более высокого уровня, таких как городские центры, округа и штаты. В ответе также возвращаются подробные свойства адреса, такие как улица, почтовый индекс, муниципалитет и информация о стране или регионе.
GET {endpoint}/geocode?api-version=2026-01-01
GET {endpoint}/geocode?api-version=2026-01-01&top={top}&query={query}&addressLine={addressLine}&countryRegion={countryRegion}&bbox={bbox}&view={view}&coordinates={coordinates}&adminDistrict={adminDistrict}&adminDistrict2={adminDistrict2}&adminDistrict3={adminDistrict3}&locality={locality}&postalCode={postalCode}
Параметры URI
| Имя | В | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
endpoint
|
path | True |
string |
|
|
api-version
|
query | True |
string minLength: 1 |
Версия API, используемая для данной операции. |
|
address
|
query |
string |
Официальная линия улицы адреса, относящаяся к району, как указано в свойствах населенного пункта или почтового индекса. Обычно этот элемент используется для указания адреса улицы или любого официального адреса. Этот параметр не следует использовать, если он |
|
|
admin
|
query |
string |
Часть адреса по стране, например WA. Этот параметр не следует использовать, если он |
|
|
admin
|
query |
string |
Округ для структурированного адреса, например, Кинг. Этот параметр не следует использовать, если он |
|
|
admin
|
query |
string |
Именованная область для структурированного адреса. Этот параметр не следует использовать, если он |
|
|
bbox
|
query |
number[] |
Прямоугольная область на земле, определенная как ограничивающий прямоугольник. Стороны прямоугольника определяются значениями долготы и широты. При указании этого параметра географическая область учитывается при вычислении результатов запроса местоположения. Пример: lon1,lat1,lon2,lat2. Минимальный размер: примерно 0,00001 градуса (~0,01 метра). Максимальный размер: до полного глобального масштаба (от -180,-90 до 180,90) |
|
|
coordinates
|
query |
number[] |
Точка на Земле, указанная как долгота и широта. При указании этого параметра учитывается местоположение пользователя, и возвращаемые результаты могут быть более актуальными для пользователя. Пример: координаты &=lon,lat |
|
|
country
|
query |
string |
Сигнал для результата геокодирования в код региона/страны ISO 3166-1 Alpha-2 , который указан, например, FR. Этот параметр не следует использовать, если он |
|
|
locality
|
query |
string |
Населенный пункт адреса, например Сиэтл. Этот параметр не следует использовать, если он |
|
|
postal
|
query |
string |
Часть адреса с почтовым индексом. Этот параметр не следует использовать, если он |
|
|
query
|
query |
string |
Строка, содержащая информацию о местоположении, например адрес или название достопримечательности. |
|
|
top
|
query |
integer (int32) minimum: 1maximum: 20 |
Максимальное количество возвращаемых ответов. По умолчанию: 5, минимум: 1 и максимум: 20. |
|
|
view
|
query |
string |
Строка, представляющая код региона илистраны ISO 3166-1 Альфа-2. Это изменит геополитические спорные границы и метки, чтобы выровняться с указанным регионом пользователя. По умолчанию параметр View имеет значение Auto, даже если он не определен в запросе. Дополнительные сведения о доступных представлениях см. в поддерживаемых представлений. |
Заголовок запроса
| Имя | Обязательно | Тип | Описание |
|---|---|---|---|
| Accept-Language |
string |
Язык, в котором должны быть возвращены результаты поиска. Дополнительные сведения см. в поддерживаемых языках. |
|
| x-ms-client-id |
string |
Указывает, какой аккаунт предназначен для использования в сочетании с моделью безопасности Azure AD. Он представляет собой уникальный идентификатор для аккаунта Azure Maps и может быть извлечен из API управления плоскостью Azure Maps Account API. Для получения дополнительной информации об использовании Microsoft Entra ID безопасности в Azure Maps см. раздел Управление аутентификацией в Azure Maps. |
Ответы
| Имя | Тип | Описание |
|---|---|---|
| 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. Любой пользователь, группа или принципал сервиса может получить доступ через встроенную роль или пользовательскую роль, состоящую из одного или нескольких разрешений Azure Maps REST API.\n\nДля реализации сценариев рекомендуем ознакомиться с концепциями аутентификационные концепции. В заключение, это определение безопасности предоставляет решение для моделирования приложений с помощью объектов, способных контролировать доступ к определённым API и областям видимости.\n\n#### Примечания\n* Это определение безопасности требует использование заголовка x-ms-client-id для указания, к какому Azure Maps ресурсу приложение запрашивает доступ. Её можно получить через API управления Maps.\n* \nAuthorization URL специфичен для экземпляра публичного облака Azure. Облака Sovereign имеют уникальные URL-адреса авторизации и конфигурации Microsoft Entra ID. \n* \nУправление доступом на основе ролей Azure настраивается с плоскости управления Azure через портал Azure, PowerShell, CLI, Azure SDKs или REST API.\n* \nИспользование Azure Maps Web SDK позволяет настраивать приложение на основе конфигурации для нескольких сценариев использования.\n* Для получения дополнительной информации о платформа удостоверений Майкрософт см. платформа удостоверений Майкрософт обзор.
Тип:
oauth2
Flow:
implicit
URL-адрес авторизации:
https://login.microsoftonline.com/common/oauth2/authorize
Области
| Имя | Описание |
|---|---|
| https://atlas.microsoft.com/.default |
subscription-key
Это общий ключ, который создаётся при Создайте Azure Maps аккаунт в Azure-портале или с помощью PowerShell, CLI, Azure SDKs или REST API.\n\n С помощью этого ключа любое приложение может получить доступ ко всем REST API. Другими словами, этот ключ может использоваться как мастер-ключ на счете, на котором они выпущены.\n\n Для публично открытых приложений мы рекомендуем использовать подход confidential client applications для доступа к Azure Maps REST API, чтобы ваш ключ можно было безопасно хранить.
Тип:
apiKey
В:
header
SAS Token
Это токен общего доступа, созданный из операции List SAS на ресурсе
Тип:
apiKey
В:
header
Примеры
Search detail address 15127 NE 24th Street, Redmond, WA
Образец запроса
GET {endpoint}/geocode?api-version=2026-01-01&addressLine=15127 NE 24th Street&adminDistrict=WA&locality=Redmond
Пример ответа
Content-Type: application/geo+json
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"properties": {
"address": {
"countryRegion": {
"name": "United States"
},
"adminDistricts": [
{
"shortName": "WA"
},
{
"shortName": "King County"
}
],
"formattedAddress": "15127 NE 24th St, Redmond, WA 98052",
"streetName": "NE 24th St",
"streetNumber": "15127",
"locality": "Redmond",
"postalCode": "98052",
"addressLine": "15127 NE 24th St"
},
"type": "Address",
"confidence": "High",
"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
]
}
]
}
Search detail address 15127 NE 24th Street, Redmond, WA by addressLine
Образец запроса
GET {endpoint}/geocode?api-version=2026-01-01&addressLine=15127 NE 24th Street Redmond WA&countryRegion=US
Пример ответа
Content-Type: application/geo+json
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"properties": {
"address": {
"countryRegion": {
"name": "United States"
},
"adminDistricts": [
{
"shortName": "WA"
},
{
"shortName": "King County"
}
],
"formattedAddress": "15127 NE 24th St, Redmond, WA 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
]
}
]
}
Search detail address 15127 NE 24th Street, Redmond, WA by query
Образец запроса
GET {endpoint}/geocode?api-version=2026-01-01&query=15127 NE 24th Street Redmond WA
Пример ответа
Content-Type: application/geo+json
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"properties": {
"address": {
"countryRegion": {
"name": "United States"
},
"adminDistricts": [
{
"shortName": "WA"
},
{
"shortName": "King County"
}
],
"formattedAddress": "15127 NE 24th St, Redmond, WA 98052",
"streetName": "NE 24th St",
"streetNumber": "15127",
"locality": "Redmond",
"postalCode": "98052",
"addressLine": "15127 NE 24th St"
},
"type": "Address",
"confidence": "High",
"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
]
}
]
}
Search landmark Empire State Building by query
Образец запроса
GET {endpoint}/geocode?api-version=2026-01-01&query=empire state building
Пример ответа
Content-Type: application/geo+json
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"properties": {
"address": {
"countryRegion": {
"name": "United States"
},
"adminDistricts": [
{
"shortName": "NY"
}
],
"formattedAddress": "Empire State Building, NY",
"locality": "New York"
},
"type": "PointOfInterest",
"confidence": "High",
"matchCodes": [
"Ambiguous"
],
"geocodePoints": [
{
"geometry": {
"type": "Point",
"coordinates": [
-73.98580932617188,
40.748435974121094
]
},
"calculationMethod": "Rooftop",
"usageTypes": [
"Display"
]
}
]
},
"geometry": {
"type": "Point",
"coordinates": [
-73.98580932617188,
40.748435974121094
]
},
"bbox": [
-73.98590850830078,
40.74833679199219,
-73.98571014404297,
40.74853515625
]
},
{
"type": "Feature",
"properties": {
"address": {
"countryRegion": {
"name": "United States"
},
"adminDistricts": [
{
"shortName": "NY"
},
{
"shortName": "New York County"
}
],
"formattedAddress": "Empire State Building, NY",
"locality": "Manhattan"
},
"type": "LandmarkBuilding",
"confidence": "High",
"matchCodes": [
"Ambiguous"
],
"geocodePoints": [
{
"geometry": {
"type": "Point",
"coordinates": [
-73.98500061035156,
40.74815368652344
]
},
"calculationMethod": "Rooftop",
"usageTypes": [
"Display"
]
}
]
},
"geometry": {
"type": "Point",
"coordinates": [
-73.98500061035156,
40.74815368652344
]
},
"bbox": [
-73.98710632324219,
40.747314453125,
-73.98412322998047,
40.74958038330078
]
}
]
}
Определения
| Имя | Описание |
|---|---|
| Address |
Адрес результата |
|
Address |
Имя подразделения в стране или регионе для адреса. |
|
Address |
Страна или регион с ее названием и кодом ISO. |
|
Azure. |
Объект ошибки. |
|
Azure. |
Ответ, содержащий сведения об ошибке. |
|
Azure. |
Объект, содержащий более конкретные сведения об ошибке. Согласно Azure рекомендациям REST API — https://aka.ms/AzureRestApiGuidelines#handling-errors. |
|
Calculation |
Метод, используемый для вычисления точки геокода. |
|
Confidence |
Уровень уверенности, что результат географического расположения соответствует. Используйте это значение с кодом соответствия, чтобы определить более полную информацию о совпадении. Достоверность геокодированного расположения основана на многих факторах, включая относительную важность геокодированного расположения и расположения пользователя, если указано. |
|
Feature |
Указывает тип |
|
Features |
Объект особенности. |
|
Features |
Свойства объекта. |
|
Feature |
Тип компонента должен быть компонентом. |
|
Geocode |
Точка геокода. |
|
Geocoding |
Этот объект возвращается из успешного вызова Geocoding |
|
Geo |
Указывает тип |
|
Geo |
Допустимый тип геометрии |
| Intersection |
Адрес результата. |
|
Match |
Энум, представляющий код совпадения. |
|
Usage |
Энум, представляющий тип употребления. |
Address
Адрес результата
| Имя | Тип | Описание |
|---|---|---|
| addressLine |
string |
AddressLine, который включает название и номер улицы |
| adminDistricts |
Имя подразделения в стране или регионе для адреса. Обычно этот элемент рассматривается как первое административное подразделение порядка, но в некоторых случаях он также содержит второй, третий или четвертый отдел порядка в стране, зависимости или регионе. |
|
| countryRegion |
Страна или регион с ее названием и кодом ISO. |
|
| formattedAddress |
string |
Свойство форматированного адреса |
| intersection |
Адрес результата. |
|
| locality |
string |
Населённый пункт |
| neighborhood |
string |
Недвижимость по соседству |
| postalCode |
string |
Свойство почтового индекса |
| streetName |
string |
Название улицы из formattedAddress |
| streetNumber |
string |
Номер на улице, если таковой имеется, из formattedAddress |
AddressAdminDistrictsItem
Имя подразделения в стране или регионе для адреса.
| Имя | Тип | Описание |
|---|---|---|
| name |
string |
Имя соответствующего поля adminDistrict, For adminDistrict[0], это может быть полное имя штата, например Вашингтон, For adminDistrict[1], это может быть полное имя округа |
| shortName |
string |
Короткое имя соответствующего поля adminDistrict для adminDistrict[0], это может быть короткое имя штата, например WA, For adminDistrict[1], это может быть короткое имя округа. |
AddressCountryRegion
Страна или регион с ее названием и кодом ISO.
| Имя | Тип | Описание |
|---|---|---|
| ISO |
string |
ISO страны или региона |
| 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 |
Если достоверность установлена на Если запрос включает местоположение или представление, то рейтинг может измениться соответствующим образом. Например, запрос местоположения для "Париж" с уверенностью возвращает "Париж, Франция" и "Париж, Техас". |
| Medium |
В некоторых ситуациях возвращенное совпадение может не совпадать с информацией, предоставленной в запросе. Например, в запросе может быть указана адресная информация, а служба геокодирования может сопоставить только почтовый индекс. В этом случае, если служба геокодирования имеет уверенность в том, что почтовый индекс соответствует данным, то устанавливается значение достоверности Если информация о расположении в запросе неоднозначна и нет дополнительных сведений для ранжирования местоположений (например, местоположения пользователя или относительная важность расположения), достоверность устанавливается в значение Если информация о местоположении в запросе не предоставляет достаточной информации для геокодирования конкретного местоположения, может быть возвращено менее точное значение местоположения, а достоверность устанавливается в |
| Low |
Low |
FeatureCollectionEnum
Указывает тип GeoJSON. Единственным поддерживаемым типом объекта является FeatureCollection. Дополнительные сведения см. в RFC 7946.
| Значение | Описание |
|---|---|
| FeatureCollection |
Указывает тип объекта |
FeaturesItem
Объект особенности.
| Имя | Тип | Описание |
|---|---|---|
| bbox |
number[] (double) |
Ограничивающий прямоугольник. Используется проекция — EPSG:3857. Дополнительные сведения см. в RFC 7946. |
| geometry |
Допустимый тип геометрии |
|
| id |
string |
Идентификатор возвращаемой функции |
| properties |
Свойства объекта. |
|
| type |
Тип компонента должен быть компонентом. |
FeaturesItemProperties
Свойства объекта.
| Имя | Тип | Описание |
|---|---|---|
| address |
Адрес результата |
|
| confidence |
Уровень уверенности, что результат географического расположения соответствует. Используйте это значение с кодом соответствия, чтобы определить более полную информацию о совпадении. Достоверность геокодированного расположения основана на многих факторах, включая относительную важность геокодированного расположения и расположения пользователя, если указано. |
|
| geocodePoints |
Коллекция точек геокода, отличающихся от способа их вычисления и их предлагаемого использования. |
|
| matchCodes |
Одно или несколько совпадающих значений кода, представляющих уровень геокодирования для каждого расположения в ответе. Например, геокодированное расположение с кодами соответствия Аналогичным образом геокодированное расположение с кодами соответствия Возможны следующие значения:
|
|
| type |
string |
Один из: * Адрес * Дорожный блок * Перекрёсток дороги * Район * Населённое место * Почтовый индекс1 * Административный отдел 1 * Административное отделение 2 * Регион страны |
FeatureTypeEnum
Тип компонента должен быть компонентом.
| Значение | Описание |
|---|---|
| Feature |
Указывает тип объекта компонента |
GeocodePointsItem
Точка геокода.
| Имя | Тип | Описание |
|---|---|---|
| calculationMethod |
Метод, используемый для вычисления точки геокода. |
|
| geometry |
Допустимый тип геометрии |
|
| usageTypes |
Лучше всего использовать для точки геокода. Каждая точка геокода определяется как точка |
GeocodingResponse
Этот объект возвращается из успешного вызова Geocoding
| Имя | Тип | Описание |
|---|---|---|
| features |
Массив признаков, возвращаемых из запроса. |
|
| nextLink |
string |
Ссылка на следующую страницу возвращаемых функций. Если это последняя страница, это поле не отображается. |
| 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
Адрес результата.
| Имя | Тип | Описание |
|---|---|---|
| baseStreet |
string |
Первичная улица для расположения. |
| displayName |
string |
Полное имя пересечения. |
| intersectionType |
string |
Тип пересечения. |
| secondaryStreet1 |
string |
Первая пересекающаяся улица. |
| secondaryStreet2 |
string |
Если таковые есть, второй пересекающийся улица. |
MatchCodesEnum
Энум, представляющий код совпадения.
| Значение | Описание |
|---|---|
| Good |
Хорошо |
| Ambiguous |
Двусмысленный |
| UpHierarchy |
UpHierarchy |
UsageTypeEnum
Энум, представляющий тип употребления.
| Значение | Описание |
|---|---|
| Display |
Display |
| Route |
Маршрут |