Search - Get Reverse Geocoding
Use para obter um endereço e informações de localização a partir de coordenadas de longitude e latitude.
A API Get Reverse Geocoding é uma solicitação de GET HTTP usada para traduzir uma coordenada (exemplo: 37.786505, -122.3862) em um endereço de rua compreensível por humanos. Útil em aplicações de rastreamento onde você recebe um feed GPS do dispositivo ou ativo e deseja saber o endereço associado às coordenadas. Esse ponto de extremidade retornará informações de endereço para uma determinada coordenada.
GET {endpoint}/reverseGeocode?api-version=2026-01-01&coordinates={coordinates}
GET {endpoint}/reverseGeocode?api-version=2026-01-01&coordinates={coordinates}&resultTypes={resultTypes}&view={view}
Parâmetros do URI
| Name | Em | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
O nome de host do serviço Azure Maps. Usa |
|
api-version
|
query | True |
string minLength: 1 |
A versão da API a utilizar para esta operação. |
|
coordinates
|
query | True |
number[] |
As coordenadas do local que você deseja reverter o geocódigo. Exemplo: &coordinates=lon,lat |
|
result
|
query |
Especifique os tipos de entidade que você deseja na resposta. Somente os tipos especificados serão retornados. Se o ponto não puder ser mapeado para os tipos de entidade especificados, nenhuma informação de localização será retornada na resposta. O valor padrão é todas as entidades possíveis. Uma lista separada por vírgulas dos tipos de entidade selecionados entre as opções a seguir.
Estes tipos de entidades são ordenados da entidade mais específica para a entidade menos específica. Quando entidades de mais de um tipo de entidade são encontradas, somente a entidade mais específica é retornada. Por exemplo, se você especificar Address e AdminDistrict1 como tipos de entidade e entidades foram encontradas para ambos os tipos, somente as informações da entidade Address serão retornadas na resposta. |
||
|
view
|
query |
string |
Uma cadeia de caracteres que representa um código de região/país ISO 3166-1 Alpha-2 . Isso alterará fronteiras e rótulos disputados geopoliticamente para se alinhar com a região de usuário especificada. Por defeito, o parâmetro View está definido como "Auto" mesmo que não o tenhas definido no pedido. Consulte de Visualizações Suportadas para obter detalhes e ver as Visualizações disponíveis. |
Cabeçalho do Pedido
| Name | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| x-ms-client-id |
string |
Especifica qual a conta destinada a ser usada em conjunto com o modelo de segurança do Azure AD. Representa um ID único para a conta Azure Maps e pode ser recuperado na API de Contas do plano de gestão do Azure Maps. Para mais informações sobre o uso da segurança Microsoft Entra ID em Azure Maps, consulte Gerir autenticação em Azure Maps. |
|
| Accept-Language |
string |
Idioma em que os resultados da pesquisa devem ser retornados. |
Respostas
| Name | Tipo | Descrição |
|---|---|---|
| 200 OK |
O pedido foi bem-sucedido. Media Types: "application/geo+json", "application/json" |
|
| Other Status Codes |
Uma resposta de erro inesperada. Media Types: "application/geo+json", "application/json" Cabeçalhos x-ms-error-code: string |
Segurança
AadToken
Estes são os fluxos Microsoft Entra OAuth 2.0. Quando combinado com controlo Azure baseado em funções, pode ser usado para controlar o acesso a APIs REST Azure Maps. Os controlos de acesso baseados em papéis do Azure são usados para designar o acesso a uma ou mais contas ou subrecursos de recursos do Azure Maps. Qualquer usuário, grupo ou entidade de serviço pode receber acesso por meio de uma função interna ou uma função personalizada composta por uma ou mais permissões para APIs REST do Azure Maps.
Para implementar cenários, recomendamos a visualização conceitos de autenticação. Em resumo, essa definição de segurança fornece uma solução para modelar aplicativos(s) por meio de objetos capazes de controle de acesso em APIs e escopos específicos.
Note
- Essa definição de segurança requer o uso do cabeçalho
x-ms-client-idpara indicar a qual recurso do Azure Maps o aplicativo está solicitando acesso. Isso pode ser adquirido na API de gerenciamento do Maps. - O
Authorization URLé específico para a instância de nuvem pública do Azure. As clouds soberanas têm URLs de Autorização e configurações de Microsoft Entra ID únicas. - O controle de acesso baseado em função do Azure é configurado a partir do plano de gerenciamento do Azure por meio do portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.
- O uso do SDK da Web do Azure Maps permite a configuração baseada em configuração de um aplicativo para vários casos de uso.
- Para obter mais informações sobre a plataforma de identidade da Microsoft, consulte visão geral da plataforma de identidade da Microsoft.
Tipo:
oauth2
Fluxo:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Âmbitos
| Name | Descrição |
|---|---|
| https://atlas.microsoft.com/.default |
subscription-key
Esta é uma chave compartilhada que é provisionada quando você Criar uma conta do Azure Maps no portal do Azure ou usando PowerShell, CLI, SDKs do Azure ou API REST.
Com essa chave, qualquer aplicativo pode acessar todas as APIs REST. Em outras palavras, essa chave pode ser usada como uma chave mestra na conta em que eles são emitidos.
Para aplicativos expostos publicamente, nossa recomendação é usar a abordagem de de aplicativos cliente confidenciais para acessar APIs REST do Azure Maps para que sua chave possa ser armazenada com segurança.
Tipo:
apiKey
Em:
header
SAS Token
Este é um token de assinatura de acesso compartilhado criado a partir da operação Listar SAS no de recursos do
Com esse token, qualquer aplicativo é autorizado a acessar com controles de acesso baseados em função do Azure e controle de grão fino para a expiração, taxa e região(ões) de uso para o token específico. Em outras palavras, o Token SAS pode ser usado para permitir que os aplicativos controlem o acesso de forma mais segura do que a chave compartilhada.
Para aplicativos expostos publicamente, nossa recomendação é configurar uma lista específica de origens permitidas no de recursos da conta do
Tipo:
apiKey
Em:
header
Exemplos
Search point -122.138681, 47.630358
Pedido de amostra
GET https://atlas.microsoft.com/reverseGeocode?api-version=2026-01-01&coordinates=-122.138681,47.630358
Resposta da amostra
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
]
}
]
}
Definições
| Name | Descrição |
|---|---|
| Address |
O endereço de uma localização geocodificada ou sugerida por autocompletamento, analisada em campos estruturados.
A escassez é normal: apenas os campos que a entidade resolvida fornece são povoados. Por exemplo, |
|
Address |
Uma subdivisão administrativa que contém um endereço. Por exemplo, um estado, província ou condado. Devolvido como uma entrada no array principal |
|
Address |
O país ou região que contém o endereço, identificado pelo seu nome de exibição e pelo código de país ISO 3166-1 Alpha-2. Qualquer um dos campos pode ser omitido numa dada resposta. |
|
Azure. |
O objeto de erro. |
|
Azure. |
Uma resposta contendo detalhes do erro. |
|
Azure. |
Um objeto que contém informações mais específicas sobre o erro. De acordo com Azure diretrizes da API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors. |
|
Calculation |
O método que foi usado para calcular o ponto de geocódigo. |
|
Confidence |
O nível de confiança de que o resultado da localização geocodificada é uma correspondência. Use este valor juntamente com os códigos de correspondência para obter informações mais completas sobre o jogo. A confiança de uma localização geocodificada baseia-se em muitos fatores, incluindo a importância relativa da localização geocodificada e a localização do utilizador, se especificada. |
|
Feature |
O |
|
Features |
Uma única entrada no |
|
Features |
A |
|
Feature |
O |
|
Geocode |
Um ponto de geocódigo para uma localização: uma coordenada mais metadados que descrevem como o ponto foi calculado ( |
|
Geocoding |
O corpo de resposta bem-sucedida retornou por |
|
Geo |
Especifica o tipo de |
|
Geo |
Um tipo de geometria |
| Intersection |
Detalhes de interseção para um endereço resolvidos como um cruzamento rodoviário — a esquina onde duas ou mais ruas nomeadas se encontram. Preenchido apenas quando a entidade resolvida é um |
|
Match |
Um valor de código de correspondência que indica como o serviço de geocodificação produziu um determinado resultado de localização. O |
|
Reverse |
Um tipo de entidade devolvido pela |
|
Usage |
O uso pretendido para um ponto de geocódigo. Um ponto de geocódigo devolvido pelo serviço transporta um ou mais tipos de utilização que indicam como uma aplicação cliente deve consumir o ponto: por exemplo, mostrar a localização num mapa versus encaminhar um veículo para ele. |
Address
O endereço de uma localização geocodificada ou sugerida por autocompletamento, analisada em campos estruturados.
A escassez é normal: apenas os campos que a entidade resolvida fornece são povoados. Por exemplo, streetName e streetNumber aparece apenas para endereços ao nível da rua, e intersection aparece apenas para resultados de interseções rodoviárias.
| Name | Tipo | Descrição |
|---|---|---|
| addressLine |
string |
A primeira linha do endereço, normalmente o nome e número da rua. Por exemplo, |
| adminDistricts |
As subdivisões administrativas que contêm o endereço, ordenadas do mais grosseiro para o mais refinado. A primeira entrada é tipicamente a subdivisão de primeira ordem (como um estado dos EUA ou uma província canadiana); Entradas subsequentes cobrem divisões mais finas onde o país, dependência ou região as define (como um condado no índice 1). |
|
| countryRegion |
O país ou região que contém o endereço, com o seu nome de exibição e o código de país ISO 3166-1 Alpha-2. |
|
| formattedAddress |
string |
O endereço completo é apresentado como uma única cadeia legível por humanos, com os componentes unidos de acordo com as convenções do país ou região do endereço. Exemplo: |
| intersection |
Os detalhes das ruas que se cruzam para o endereço, preenchidos quando a entidade resolvida é um |
|
| locality |
string |
A localidade onde o endereço se encontra: normalmente uma cidade, vila ou aldeia. Por exemplo: |
| neighborhood |
string |
O bairro nomeado dentro da localidade, quando um é identificado. |
| postalCode |
string |
O código postal do endereço, quando definido um. Exemplo: |
| streetName |
string |
O componente do nome da rua do endereço, quando a entidade resolvida é um endereço ao nível da rua. Exemplo: |
| streetNumber |
string |
O número da casa ou edifício na rua, quando a entidade resolvida é um endereço ao nível da rua. Exemplo: |
AddressAdminDistrictsItem
Uma subdivisão administrativa que contém um endereço. Por exemplo, um estado, província ou condado. Devolvido como uma entrada no array principal Address.adminDistricts , onde as entradas são ordenadas do mais grosseiro para o mais fino.
| Name | Tipo | Descrição |
|---|---|---|
| name |
string |
O nome completo do loteamento. Por exemplo, |
| shortName |
string |
A forma abreviada ou abreviada do nome da subdivisão, quando é definido. Por exemplo, |
AddressCountryRegion
O país ou região que contém o endereço, identificado pelo seu nome de exibição e pelo código de país ISO 3166-1 Alpha-2. Qualquer um dos campos pode ser omitido numa dada resposta.
| Name | Tipo | Descrição |
|---|---|---|
| ISO |
string |
O código de país ISO 3166-1 Alpha-2 para o país ou região. Por exemplo, |
| name |
string |
O nome de exibição do país ou região. Por exemplo, |
Azure.Core.Foundations.Error
O objeto de erro.
| Name | Tipo | Descrição |
|---|---|---|
| code |
string |
Um de um conjunto de códigos de erro definido pelo servidor. |
| details |
Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado. |
|
| innererror |
Um objeto que contém informações mais específicas do que o objeto atual sobre o erro. |
|
| message |
string |
Uma representação legível por humanos do erro. |
| target |
string |
O alvo do erro. |
Azure.Core.Foundations.ErrorResponse
Uma resposta contendo detalhes do erro.
| Name | Tipo | Descrição |
|---|---|---|
| error |
O objeto de erro. |
Azure.Core.Foundations.InnerError
Um objeto que contém informações mais específicas sobre o erro. De acordo com Azure diretrizes da API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors.
| Name | Tipo | Descrição |
|---|---|---|
| code |
string |
Um de um conjunto de códigos de erro definido pelo servidor. |
| innererror |
Erro interno. |
CalculationMethodEnum
O método que foi usado para calcular o ponto de geocódigo.
| Valor | Descrição |
|---|---|
| Interpolation |
O ponto de geocódigo foi combinado com um ponto em uma estrada usando interpolação. |
| InterpolationOffset |
O ponto de geocódigo foi combinado com um ponto em uma estrada usando interpolação com um deslocamento adicional para deslocar o ponto para o lado da rua. |
| Parcel |
O ponto de geocódigo foi combinado com o centro de uma parcela. |
| Rooftop |
O ponto de geocódigo foi combinado com o telhado de um edifício. |
ConfidenceEnum
O nível de confiança de que o resultado da localização geocodificada é uma correspondência. Use este valor juntamente com os códigos de correspondência para obter informações mais completas sobre o jogo.
A confiança de uma localização geocodificada baseia-se em muitos fatores, incluindo a importância relativa da localização geocodificada e a localização do utilizador, se especificada.
| Valor | Descrição |
|---|---|
| High |
Se a confiança estiver definida como Se um pedido incluir uma localização ou uma vista, a classificação pode mudar em conformidade. Por exemplo, uma consulta de localização para "Paris" devolve tanto "Paris, França" como "Paris, TX" com |
| Medium |
Em algumas situações, a correspondência devolvida pode não estar no mesmo nível das informações fornecidas na solicitação. Por exemplo, uma solicitação pode especificar informações de endereço e o serviço de geocodificação só pode corresponder a um código postal. Neste caso, se o serviço de geocodificação tiver confiança de que o código postal corresponde aos dados, a confiança é definida como Se as informações de localização na consulta forem ambíguas e não houver informações adicionais para classificar os locais (como a localização do usuário ou a importância relativa do local), a confiança será definida como Se as informações de localização na consulta não fornecerem informações suficientes para geocodificar um local específico, um valor de localização menos preciso poderá ser retornado e a confiança será definida como |
| Low |
Baixa confiança no combate. |
FeatureCollectionEnum
O GeoJSON tipo de objeto utilizado na raiz das respostas bem-sucedidas das operações de geocodificação direta, geocodificação reversa e autocompletar (incluindo as suas variantes em lote). O único valor é FeatureCollection, conforme definido no RFC 7946.
Get Polygon é a única exceção: a sua raiz de resposta é um GeoJSON Feature, veja FeatureTypeEnum.
| Valor | Descrição |
|---|---|
| FeatureCollection |
O tipo de |
FeaturesItem
Uma única entrada no features array de um GeocodingResponse, conforme a forma do GeoJSON Feature objeto.
Representa uma localização geocodificada: dados estruturados em properties, uma coordenada representativa em geometry, e uma caixa delimitadora opcional em bbox.
| Name | Tipo | Descrição |
|---|---|---|
| bbox |
number[] (double) |
O retângulo mais pequeno alinhado ao eixo que contém a geometria da estrutura, na ordem WGS 84 de longitude/latitude. Codificado conforme |
| geometry |
O primário |
|
| id |
string |
Um identificador opcional atribuído pelo serviço para a funcionalidade, quando estiver disponível. |
| properties |
Dados estruturados sobre a localização geocodificada, incluindo o seu tipo de entidade, indicadores de qualidade de correspondência, componentes de endereço e um ou mais pontos de geocodificação. |
|
| type |
O tipo de |
FeaturesItemProperties
A properties carga útil de uma funcionalidade num GeocodingResponse. Transporta os indicadores de tipo de entidade e de qualidade de correspondência para a localização geocodificada, os seus componentes de endereço analisados e um ou mais pontos de geocódigo que associam a localização a coordenadas específicas.
| Name | Tipo | Descrição |
|---|---|---|
| address |
O endereço da localização geocodificada, dividido em campos estruturados como localidade, código postal, país/região e (quando disponível) nome e número da rua. |
|
| confidence |
Quão fortemente a localização geocodificada corresponde ao pedido. Utilize-o juntamente |
|
| geocodePoints |
Um ou mais pontos de geocódigo para a localização, cada um marcado com a forma como foi derivada ( |
|
| matchCodes |
Como o serviço de geocodificação produziu este resultado em relação à consulta: uma correspondência direta na especificidade solicitada ( |
|
| type |
string |
O tipo de entidade para o qual a localização geocodificada foi resolvida. Um de: |
FeatureTypeEnum
O GeoJSON tipo de objeto para Feature os objetos. Etiqueta cada entrada dentro do features array de uma FeatureCollection resposta (geocodificação, geocodificação reversa, autocompletamento) e aparece na raiz da Get Polygon resposta. O único valor é Feature, conforme definido no RFC 7946.
| Valor | Descrição |
|---|---|
| Feature |
O tipo de |
GeocodePointsItem
Um ponto de geocódigo para uma localização: uma coordenada mais metadados que descrevem como o ponto foi calculado (calculationMethod) e para que é mais adequado (usageTypes). Uma única funcionalidade normalmente retorna separadas Display e Route aponta para que os chamadores possam escolher a que se adequa à tarefa.
| Name | Tipo | Descrição |
|---|---|---|
| calculationMethod |
Como o ponto era calculado. Por exemplo, encaixado no telhado de um edifício ou interpolado ao longo da linha central de uma estrada. Veja |
|
| geometry |
A coordenada deste geocódigo aponta como um |
|
| usageTypes |
Para que o ponto de geocódigo é mais adequado — |
GeocodingResponse
O corpo de resposta bem-sucedida retornou por Get Geocoding e Get Reverse Geocoding, e a forma de sucesso por item por lote transportada dentro GeocodingBatchResponse.batchItemsde .
Codificado como um GeoJSON FeatureCollection cujo features array contém um Feature por cada localização geocodificada.
| Name | Tipo | Descrição |
|---|---|---|
| features |
O array de |
|
| nextLink |
string |
Contém o URL para obter a página seguinte de resultados se a resposta for paginada. Isto é útil quando a resposta é demasiado grande para ser devolvida numa única chamada, permitindo aos utilizadores navegar por várias páginas de resultados. |
| type |
O |
GeoJsonObjectType
Especifica o tipo de GeoJSON. Deve ser um dos nove tipos de objeto GeoJSON válidos - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.
| Valor | Descrição |
|---|---|
| Point |
|
| MultiPoint |
|
| LineString |
|
| MultiLineString |
|
| Polygon |
|
| MultiPolygon |
|
| GeometryCollection |
|
| Feature |
|
| FeatureCollection |
|
GeoJsonPoint
Um tipo de geometria GeoJSON Point válido. Consulte RFC 7946 para obter detalhes.
Intersection
Detalhes de interseção para um endereço resolvidos como um cruzamento rodoviário — a esquina onde duas ou mais ruas nomeadas se encontram. Preenchido apenas quando a entidade resolvida é um RoadIntersection; o pai Address.intersection é de outra forma omitido.
| Name | Tipo | Descrição |
|---|---|---|
| baseStreet |
string |
A rua principal do cruzamento — normalmente a rua que o número de morada refere. |
| displayName |
string |
Um nome legível por humanos para o cruzamento que combina as ruas transversais, como |
| intersectionType |
string |
Um pequeno rótulo que descreve a forma da interseção. Por exemplo, distinguir um cruzamento ao nível de um cruzamento a nível separado, como uma ponte ou um viaduto. |
| secondaryStreet1 |
string |
A primeira rua transversal que se encontra |
| secondaryStreet2 |
string |
A segunda rua transversal na interseção, quando há uma. Populado apenas para interseções de três ou mais ruas. |
MatchCodesEnum
Um valor de código de correspondência que indica como o serviço de geocodificação produziu um determinado resultado de localização. O matchCodes campo numa característica é um array destes valores; combine-os com confidence e type para avaliar a qualidade da correspondência.
| Valor | Descrição |
|---|---|
| Good |
O serviço de geocodificação produziu este candidato sem alargar a consulta: o resultado corresponde à consulta na especificidade solicitada. |
| Ambiguous |
A localização é uma de um conjunto de possíveis correspondências. Por exemplo, ao consultar a morada "128 Main St.", a resposta pode devolver duas localizações para "128 North Main St." e "128 South Main St." porque não há informação suficiente para determinar qual opção escolher. |
| UpHierarchy |
A localização representa uma subida na hierarquia geográfica. Isso ocorre quando uma correspondência para a solicitação de local não foi encontrada, portanto, um resultado menos preciso é retornado. |
ReverseGeocodingResultTypeEnum
Um tipo de entidade devolvido pela Get Reverse Geocoding operação. Fornecido como um ou mais valores no resultTypes parâmetro de consulta para restringir a resposta a tipos específicos de localizações; quando o parâmetro é omitido, todos os tipos de entidade são elegíveis. Quando entidades de mais do que um tipo correspondem a uma coordenada, apenas a mais específica é retornada. Listados do mais específico ao menos específico: Address, Neighborhood, PopulatedPlacePostcode1, AdminDivision1, , AdminDivision2, , . CountryRegion
| Valor | Descrição |
|---|---|
| Address |
Uma morada específica. |
| Neighborhood |
Uma área reconhecida localmente dentro de um local povoado, frequentemente com limites informais ou culturalmente definidos. |
| PopulatedPlace |
Uma área concentrada de assentamento humano, como uma cidade, vila ou aldeia. |
| Postcode1 |
A menor categoria de código postal, como um código postal. |
| AdminDivision1 |
Primeiro nível administrativo dentro do país/região, como um estado ou província. |
| AdminDivision2 |
Segundo nível administrativo dentro do país/região, como um condado. |
| CountryRegion |
Um país ou região. |
UsageTypeEnum
O uso pretendido para um ponto de geocódigo. Um ponto de geocódigo devolvido pelo serviço transporta um ou mais tipos de utilização que indicam como uma aplicação cliente deve consumir o ponto: por exemplo, mostrar a localização num mapa versus encaminhar um veículo para ele.
| Valor | Descrição |
|---|---|
| Display |
O ponto de geocódigo é adequado para mostrar a localização num mapa. Para uma característica com extensão não trivial (como um parque ou edifício), o |
| Route |
O ponto de geocódigo é adequado como destino de uma rota. Para uma característica com extensão não trivial (como um parque ou edifício), o |