Search - Get Geocoding
Use para obter coordenadas de longitude e latitude de um endereço de rua ou nome de um lugar.
A Get Geocoding API é uma solicitação HTTP GET que retorna as coordenadas de longitude e latitude do local que está sendo pesquisado.
Em muitos casos, o serviço de pesquisa completo pode ser demais, por exemplo, se você estiver interessado apenas na geocodificação tradicional. A pesquisa também pode ser acessada para pesquisa de endereço exclusivamente. A geocodificação é realizada batendo no ponto de extremidade de geocodificação apenas com o endereço ou endereço parcial em questão. O índice de pesquisa de geocodificação será consultado para tudo acima dos dados do nível da rua. Nenhum Ponto de Interesse (POIs) será devolvido. Note que o geocodificador é muito tolerante a erros de digitação e endereços incompletos. Ele também lidará com tudo, desde endereços exatos de ruas ou ruas ou cruzamentos, bem como geografias de nível superior, como centros urbanos, condados e estados. A resposta também retorna propriedades de endereço detalhadas, como rua, código postal, município e informações de país/região.
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}
Parâmetros do URI
| Name | Em | Necessário | Tipo | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string |
|
|
api-version
|
query | True |
string minLength: 1 |
A versão da API a utilizar para esta operação. |
|
address
|
query |
string |
A linha de rua oficial de um endereço relativo à área, conforme especificado pela localidade, ou postalCode, propriedades. O uso típico deste elemento seria fornecer um endereço ou qualquer endereço oficial. Este parâmetro não deve ser usado quando o |
|
|
admin
|
query |
string |
A parte de subdivisão de país de um endereço, como WA. Este parâmetro não deve ser usado quando o |
|
|
admin
|
query |
string |
O condado para o endereço estruturado, como King. Este parâmetro não deve ser usado quando o |
|
|
admin
|
query |
string |
A área nomeada para o endereço estruturado. Este parâmetro não deve ser usado quando o |
|
|
bbox
|
query |
number[] |
Uma área retangular na Terra definida como um objeto de caixa delimitadora. Os lados do retângulo são definidos por valores de longitude e latitude. Quando você especifica esse parâmetro, a área geográfica é levada em conta ao calcular os resultados de uma consulta de local. Exemplo: lon1,lat1,lon2,lat2. Tamanho mínimo: aproximadamente 0,00001 graus (~0,01 metros). Tamanho máximo: até a extensão global total (-180,-90 a 180,90) |
|
|
coordinates
|
query |
number[] |
Um ponto na Terra especificado como longitude e latitude. Quando você especifica esse parâmetro, a localização do usuário é levada em conta e os resultados retornados podem ser mais relevantes para o usuário. Exemplo: &coordinates=lon,lat |
|
|
country
|
query |
string |
Sinal para o resultado da geocodificação para um código de região/país ISO 3166-1 Alpha-2 especificado, por exemplo, FR. Este parâmetro não deve ser usado quando o |
|
|
locality
|
query |
string |
A parte da localidade de um endereço, como Seattle. Este parâmetro não deve ser usado quando o |
|
|
postal
|
query |
string |
A parte do código postal de um endereço. Este parâmetro não deve ser usado quando o |
|
|
query
|
query |
string |
Uma cadeia de caracteres que contém informações sobre um local, como um endereço ou nome de ponto de referência. |
|
|
top
|
query |
integer (int32) minimum: 1maximum: 20 |
Número máximo de respostas que serão devolvidas. Padrão: 5, mínimo: 1 e máximo: 20. |
|
|
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 padrão, o parâmetro View é definido como "Auto", mesmo que você não o tenha definido na solicitação. Consulte de Visualizações Suportadas para obter detalhes e ver as Visualizações disponíveis. |
Cabeçalho do Pedido
| Name | Necessário | Tipo | Description |
|---|---|---|---|
| Accept-Language |
string |
Idioma em que os resultados da pesquisa devem ser retornados. |
|
| 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. |
Respostas
| Name | Tipo | Description |
|---|---|---|
| 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 utilizador, grupo ou principal de serviço pode receber acesso através de um papel incorporado ou de um papel personalizado composto por uma ou mais permissões para Azure Maps APIs REST.\n\nPara implementar cenários, recomendamos consultar conceitos autenticação. Em resumo, esta definição de segurança fornece uma solução para modelar aplicações(ões) através de objetos capazes de controlo de acesso em APIs e escopos específicos.\n\n#### Notas\n* Esta definição de segurança exige a utilização do cabeçalho x-ms-client-id para indicar a que Azure Maps recurso a aplicação está a pedir acesso. Isto pode ser adquirido da API de gestão Maps.\n* \nO Authorization URL é específico para a instância Azure cloud pública. As clouds soberanas têm URLs de Autorização e configurações de Microsoft Entra ID únicas. \n* \nO controlo de acesso Azure baseado em funções é configurado a partir do plano de gestão Azure via portal Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.\n* \nUtilização do Azure Maps Web SDK permite a configuração de uma aplicação para múltiplos casos de uso.\n* Para mais informações sobre plataforma de identidades da Microsoft, consulte plataforma de identidades da Microsoft visão geral.
Tipo:
oauth2
Fluxo:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Âmbitos
| Name | Description |
|---|---|
| https://atlas.microsoft.com/.default |
subscription-key
Esta é uma chave partilhada que é provisionada quando Cria uma conta Azure Maps no portal Azure ou usando PowerShell, CLI, SDKs do Azure ou API REST.\n\n Com esta chave, qualquer aplicação pode aceder a toda a API REST. Ou seja, esta chave pode ser usada como chave mestra na conta onde são emitidas.\n\n Para aplicações expostas publicamente, a nossa recomendação é usar a abordagem confidenciais de aplicações cliente para aceder às APIs REST Azure Maps para que a sua chave possa ser armazenada de forma segura.
Tipo:
apiKey
Em:
header
SAS Token
Este é um token de assinatura de acesso partilhado criado a partir da operação List SAS no recurso Azure Maps através do plano de gestão Azure via portal Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.\n\n Com este token, qualquer aplicação está autorizada a aceder com Azure controlos de acesso baseados em funções e controlo minucioso da expiração, taxa e região(s) de utilização para o token em questão. Por outras palavras, o Token SAS pode ser usado para permitir que aplicações controlem o acesso de forma mais segura do que a chave partilhada.\n\n Para aplicações publicamente expostas, a nossa recomendação é configurar uma lista específica de origens permitidas no recurso da conta Map para limitar abusos de renderização e renovar regularmente o Token SAS.
Tipo:
apiKey
Em:
header
Exemplos
Search detail address 15127 NE 24th Street, Redmond, WA
Pedido de amostra
GET {endpoint}/geocode?api-version=2026-01-01&addressLine=15127 NE 24th Street&adminDistrict=WA&locality=Redmond
Resposta da amostra
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
Pedido de amostra
GET {endpoint}/geocode?api-version=2026-01-01&addressLine=15127 NE 24th Street Redmond WA&countryRegion=US
Resposta da amostra
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
Pedido de amostra
GET {endpoint}/geocode?api-version=2026-01-01&query=15127 NE 24th Street Redmond WA
Resposta da amostra
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
Pedido de amostra
GET {endpoint}/geocode?api-version=2026-01-01&query=empire state building
Resposta da amostra
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
]
}
]
}
Definições
| Name | Description |
|---|---|
| Address |
O endereço do resultado |
|
Address |
O nome da subdivisão no país ou região de um endereço. |
|
Address |
País ou região com o seu nome e código ISO. |
|
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 esse valor com o código de correspondência para determinar informações mais completas sobre a correspondência. 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 |
Especifica o tipo de |
|
Features |
Um objeto de funcionalidade. |
|
Features |
Propriedades da funcionalidade. |
|
Feature |
O tipo de recurso deve ser Recurso. |
|
Geocode |
Um ponto de geocódigo. |
|
Geocoding |
Este objeto é retornado de uma chamada de Geocoding bem-sucedida |
|
Geo |
Especifica o tipo de |
|
Geo |
Um tipo de geometria |
| Intersection |
O endereço do resultado. |
|
Match |
Um enum que representa o código de correspondência. |
|
Usage |
Um enum que representa o tipo de uso. |
Address
O endereço do resultado
| Name | Tipo | Description |
|---|---|---|
| addressLine |
string |
AddressLine que inclui o nome e o número da rua |
| adminDistricts |
O nome da subdivisão no país ou região de um endereço. Este elemento é normalmente tratado como a subdivisão administrativa de primeira ordem, mas em alguns casos também contém a subdivisão de segunda, terceira ou quarta ordem em um país, dependência ou região. |
|
| countryRegion |
País ou região com o seu nome e código ISO. |
|
| formattedAddress |
string |
Propriedade de endereço formatado |
| intersection |
O endereço do resultado. |
|
| locality |
string |
Propriedade de localidade |
| neighborhood |
string |
Propriedade do bairro |
| postalCode |
string |
Propriedade do código postal |
| streetName |
string |
O nome da rua de formattedAddress |
| streetNumber |
string |
O número na rua, se disponível, de formattedAddress |
AddressAdminDistrictsItem
O nome da subdivisão no país ou região de um endereço.
| Name | Tipo | Description |
|---|---|---|
| name |
string |
O nome para o campo adminDistrict correspondente, Para adminDistrict[0], este poderia ser o nome completo do estado, como Washington, Para adminDistrict[1], este poderia ser o nome completo do condado |
| shortName |
string |
O nome curto para o campo adminDistrict correspondente, Para adminDistrict[0], este poderia ser o nome curto do estado, como WA, Para adminDistrict[1], este poderia ser o nome curto do condado |
AddressCountryRegion
País ou região com o seu nome e código ISO.
| Name | Tipo | Description |
|---|---|---|
| ISO |
string |
ISO do país/região |
| name |
string |
nome do país/região |
Azure.Core.Foundations.Error
O objeto de erro.
| Name | Tipo | Description |
|---|---|---|
| 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 | Description |
|---|---|---|
| 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 | Description |
|---|---|---|
| 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 | Description |
|---|---|
| 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 esse valor com o código de correspondência para determinar informações mais completas sobre a correspondência.
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 | Description |
|---|---|
| High |
Se a confiança estiver definida como Se uma solicitação incluir um local ou uma exibição, a classificação pode mudar apropriadamente. Por exemplo, uma consulta de localização para "Paris" retorna "Paris, França" e "Paris, TX" ambos 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. Nesse caso, se o serviço de geocódigo tiver uma confiança de que o código postal corresponde aos dados, a confiança será 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 |
Baixo |
FeatureCollectionEnum
Especifica o tipo de GeoJSON. O único tipo de objeto suportado é FeatureCollection. Para obter mais informações, consulte RFC 7946.
| Valor | Description |
|---|---|
| FeatureCollection |
Especifica o tipo de objeto |
FeaturesItem
Um objeto de funcionalidade.
FeaturesItemProperties
Propriedades da funcionalidade.
| Name | Tipo | Description |
|---|---|---|
| address |
O endereço do resultado |
|
| confidence |
O nível de confiança de que o resultado da localização geocodificada é uma correspondência. Use esse valor com o código de correspondência para determinar informações mais completas sobre a correspondência. 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. |
|
| geocodePoints |
Uma coleção de pontos de geocódigo que diferem em como eles foram calculados e seu uso sugerido. |
|
| matchCodes |
Um ou mais valores de código de correspondência que representam o nível de geocodificação para cada local na resposta. Por exemplo, um local geocodificado com códigos de correspondência de Da mesma forma, um local geocodificado com códigos de correspondência de Os valores possíveis são:
|
|
| type |
string |
Um deus: * Morada * Estrada * Interseção Rodoviária * Bairro * Povoado * Código Postal 1 * DivisãoAdministrativa1 * DivisãoAdministrativa2 * PaísRegião |
FeatureTypeEnum
O tipo de recurso deve ser Recurso.
| Valor | Description |
|---|---|
| Feature |
Especifica o tipo de objeto |
GeocodePointsItem
Um ponto de geocódigo.
GeocodingResponse
Este objeto é retornado de uma chamada de Geocoding bem-sucedida
| Name | Tipo | Description |
|---|---|---|
| features |
Uma série de funcionalidades retornadas da consulta. |
|
| nextLink |
string |
O é o link para a próxima página dos recursos retornados. Se for a última página, não há este campo. |
| type |
Especifica o tipo de |
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 | Description |
|---|---|
| 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
O endereço do resultado.
| Name | Tipo | Description |
|---|---|---|
| baseStreet |
string |
Rua principal para o local. |
| displayName |
string |
Nome completo do cruzamento. |
| intersectionType |
string |
Tipo de intersecção. |
| secondaryStreet1 |
string |
A primeira rua que se cruza. |
| secondaryStreet2 |
string |
Se houver, a segunda rua que se cruza. |
MatchCodesEnum
Um enum que representa o código de correspondência.
| Valor | Description |
|---|---|
| Good |
Bom |
| Ambiguous |
Ambíguo |
| UpHierarchy |
UpHierarchy |
UsageTypeEnum
Um enum que representa o tipo de uso.
| Valor | Description |
|---|---|
| Display |
Ecrã |
| Route |
Percurso |